GKVoiceChatService

Наследование

NSObject
GKVoiceChatService

Соответствует

NSObject

Оператор импорта

Swift

import GameKit

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.

GKVoiceChatService класс позволяет Вашему приложению подключать два устройства на iOS в голосовой чат.

Прежде чем можно будет использовать голосовой чат, приложение должно сконфигурировать аудио сеанс, допускающий и игру и записывающий (kAudioSessionCategory_PlayAndRecord). Для получения дополнительной информации об аудио сеансах см. Аудио Руководство по программированию Сеанса.

Служба голосового чата использует a client реализованный Вашим приложением, чтобы найти и соединиться с другими участниками. Каждый участник чата идентифицируется уникальной участвующей строкой идентификатора. Клиент предоставляет участвующий идентификатор локальному пользователю и переводит другие участвующие идентификаторы в соединения с другими пользователями. Формат и механизм, используемый для перевода участвующих идентификаторов в сетевые соединения, определяются клиентом. См. Игровое Руководство по программированию Центра для более полного обсуждения.

Ваше приложение может сконфигурировать службу голосового чата, чтобы управлять уровнем громкости и локальных и удаленных участников и обнаружить, когда кто-то говорит.

Для использования службы голосового чата приложение получает службу по умолчанию и присоединяет клиент к нему, тогда или подключения к другому участнику или ожидает их для запуска соединения.

Определение, доступен ли голосовой чат

+ isVoIPAllowed (iOS 7.0)

Возвраты, позволяют ли голосовому чату использоваться на устройстве.

Объявление

Objective C

+ (BOOL)isVoIPAllowed

Возвращаемое значение

YEStrue если голосовой чат доступен приложению.

Обсуждение

Некоторые страны или телефонные поставщики услуг могут ограничить доступность служб речи по IP. Прежде, чем получить совместно используемый объект службы голосового чата, Ваше приложение должно проверить, чтобы видеть, доступен ли голосовой чат.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 4.1 и позже.
Осуждаемый в iOS 7.0.

Получение совместно используемой службы голосового чата

+ defaultVoiceChatService (iOS 7.0)

Получает одноэлементную службу чата.

Объявление

Objective C

+ (GKVoiceChatService *)defaultVoiceChatService

Возвращаемое значение

Служба чата.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.

Установка клиента

client (iOS 7.0) Свойство

Объект, что использование службы голосового чата для передачи с удаленными участниками.

Объявление

Objective C

@property(assign) id< GKVoiceChatClient > client

Обсуждение

Главная ответственность клиента состоит в том, чтобы обеспечить сетевое соединение, которое служба голосового чата может использовать для соединения с другим участником.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.

Установление голосового чата


    
    - startVoiceChatWithParticipantID:error:

(iOS 7.0)

Отправляет запрос другому участнику для присоединения к голосовому чату.

Объявление

Objective C

- (BOOL)startVoiceChatWithParticipantID:(NSString *)participantID error:(NSError **)error

Параметры

`participantID`	Строка, однозначно определяющая участника для соединения с.
`error`	Если ошибка происходит, по возврату содержит `NSError` объект, описывающий проблему. Передача `NULL` если Вы не хотите информации об ошибке.

Возвращаемое значение

YEStrue если успешно создавалось соединение.

Обсуждение

Служебные вызовы голосового чата клиент voiceChatService:sendData:toParticipantID: метод, чтобы отправить запрос на установление соединения удаленному участнику.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.

Осуждаемый в iOS 7.0.

Корректировка аудио свойств

microphoneMuted (iOS 7.0) Свойство

Булево значение, определяющее, отключен ли микрофон пользователя звук.

Объявление

Objective C

@property(nonatomic, getter=isMicrophoneMuted) BOOL microphoneMuted

Обсуждение

YEStrue если выключен микрофон пользователя; NOfalse если речь пользователя передается удаленным участникам. Значение по умолчанию NOfalse.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.
remoteParticipantVolume (iOS 7.0) Свойство

Плавание, масштабирующее объем всех удаленных участников.

Объявление

Objective C

@property(nonatomic) float remoteParticipantVolume

Обсуждение

Значение должно быть между 0.0 (отключенный звук) и 1.0 (полный объем). Значение по умолчанию 1.0.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.

Контроль уровня звука

inputMeteringEnabled (iOS 7.0) Свойство

Булево значение, указывающее, контролируется ли уровень звука микрофона.

Объявление

Objective C

@property(nonatomic, getter=isInputMeteringEnabled) BOOL inputMeteringEnabled

Обсуждение

Если YEStrue, Ваше приложение может читать inputMeterLevel свойство для контроля уровня звука микрофона. Если NOfalse, значение inputMeterLevel свойство не определено. Значение по умолчанию NOfalse. Когда Ваше приложение не должно контролировать микрофон, оно должно установить это свойство в NOfalse улучшить производительность.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.

См. также

inputMeterLevel
inputMeterLevel (iOS 7.0) Свойство

Объем, в децибелах (дБ), получаемых микрофоном. (только для чтения)

Объявление

Objective C

@property(readonly) float inputMeterLevel

Обсуждение

Значение этого свойства не определено если inputMeteringEnabled установлен в NOfalse.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.

См. также

inputMeteringEnabled
outputMeteringEnabled (iOS 7.0) Свойство

Булево значение, указывающее, контролируется ли речевой уровень удаленных участников.

Объявление

Objective C

@property(nonatomic, getter=isOutputMeteringEnabled) BOOL outputMeteringEnabled

Обсуждение

Если YEStrue, Ваше приложение может читать outputMeterLevel свойство для контроля уровня звука удаленных участников. Если NOfalse, значение outputMeterLevel свойство не определено. Значение по умолчанию NOfalse. Когда Ваше приложение не должно контролировать удаленных участников, оно должно установить это свойство в NOfalse улучшить производительность.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.
outputMeterLevel (iOS 7.0) Свойство

Объем, в децибелах (дБ), получаемых от всех других участников. (только для чтения)

Объявление

Objective C

@property(readonly) float outputMeterLevel

Обсуждение

Значение этого свойства не определено если outputMeteringEnabled установлен в NOfalse.

Уровень громкости является совокупным объемом всех удаленных участников, измененных remoteParticipantVolume свойство.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.

Окончание голосового чата

- stopVoiceChatWithParticipantID: (iOS 7.0)

Заканчивает ранее установленный голосовой чат.

Объявление

Objective C

- (void)stopVoiceChatWithParticipantID:(NSString *)participantID

Параметры

participantID

Строка, однозначно определяющая участника чата.

Обсуждение

Когда этот метод вызывают, клиент voiceChatService:didStopWithParticipantID:error: метод вызывают.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.

Методы вызывает клиент


    
    - acceptCallID:error:

(iOS 7.0)

Принимает, что запрос от удаленного пользователя устанавливает голосовой чат.

Объявление

Objective C

- (BOOL)acceptCallID:(NSInteger)callID error:(NSError **)error

Параметры

`callID`	Целое число, идентифицирующее запрос на установление соединения.
`error`	Если ошибка происходит, по возврату содержит `NSError` объект, описывающий проблему. Передача `NULL` если Вы не хотите информации об ошибке.

Возвращаемое значение

YEStrue если было установлено соединение; иначе NOfalse.

Обсуждение

Когда удаленный пользователь запрашивает голосовой чат, служебные вызовы голосового чата клиент voiceChatService:didReceiveInvitationFromParticipantID:callID: метод. Клиент вызывает этот метод для принятия запроса или denyCallID: отклонить его.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.

Осуждаемый в iOS 7.0.

- denyCallID: (iOS 7.0)

Отклоняет запрос для установления голосового чата.

Объявление

Objective C

- (void)denyCallID:(NSInteger)callID

Параметры

callID

Целое число, идентифицирующее запрос на установление соединения.

Обсуждение

Когда удаленный пользователь запрашивает голосовой чат, служебные вызовы голосового чата клиент voiceChatService:didReceiveInvitationFromParticipantID:callID: метод. Клиент вызывает этот метод для отклонения запроса или acceptCallID:error: принять его.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.


    
    - receivedData:fromParticipantID:

(iOS 7.0)

Вызванный клиентом для поставки новых данных, полученных от удаленного участника.

Объявление

Objective C

- (void)receivedData:(NSData *)arbitraryData fromParticipantID:(NSString *)participantID

Параметры

`arbitraryData`	Данные получены от участника.
`participantID`	Строка, однозначно определяющая участника, отправившего данные.

Обсуждение

Служба голосового чата использует сетевое соединение, предоставленное клиентом для обмена информацией между участниками. Когда клиент получает информацию, предназначенную для службы голосового чата, она должна вызвать этот метод для передачи его.

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.

Осуждаемый в iOS 7.0.

См. также

voiceChatService:sendData:toParticipantID:


    
    - receivedRealTimeData:fromParticipantID:

(iOS 7.0)

Вызванный клиентом для поставки речевой информации, полученной от удаленного участника..

Объявление

Objective C

- (void)receivedRealTimeData:(NSData *)audio fromParticipantID:(NSString *)participantID

Параметры

`audio`	Аудиоданные, полученные от другого участника.
`participantID`	Строка, однозначно определяющая говорящего участника.

Обсуждение

Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.

Осуждаемый в iOS 7.0.

См. также

voiceChatService:sendRealTimeData:toParticipantID:

Константы

Ошибочный домен службы голосового чата
GKVoiceChatService ошибочный домен.

Объявление

Swift

let GKVoiceChatServiceErrorDomain: String

Objective C

NSString * const GKVoiceChatServiceErrorDomain;

Константы
- GKVoiceChatServiceErrorDomain
  
  Ошибка произошла в GKVoiceChatService.
  
  Доступный в iOS 3.0 и позже.
Ошибки службы голосового чата
Коды ошибки для GKVoiceChatService ошибочный домен.

Объявление

Objective C

typedef enum { GKVoiceChatServiceInternalError = 32000, GKVoiceChatServiceNoRemotePacketsError = 32001, GKVoiceChatServiceUnableToConnectError = 32002, GKVoiceChatServiceRemoteParticipantHangupError = 32003, GKVoiceChatServiceInvalidCallIDError = 32004, GKVoiceChatServiceAudioUnavailableError = 32005, GKVoiceChatServiceUninitializedClientError = 32006, GKVoiceChatServiceClientMissingRequiredMethodsError = 32007, GKVoiceChatServiceRemoteParticipantBusyError = 32008, GKVoiceChatServiceRemoteParticipantCancelledError = 32009, GKVoiceChatServiceRemoteParticipantResponseInvalidError = 32010, GKVoiceChatServiceRemoteParticipantDeclinedInviteError = 32011, GKVoiceChatServiceMethodCurrentlyInvalidError = 32012, GKVoiceChatServiceNetworkConfigurationError = 32013, GKVoiceChatServiceUnsupportedRemoteVersionError = 32014, GKVoiceChatServiceOutOfMemoryError = 32015, GKVoiceChatServiceInvalidParameterError = 32016 } GKVoiceChatServiceError;

Константы
- GKVoiceChatServiceInternalError
  
  Серьезная ошибка произошла в службе голосового чата.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceNoRemotePacketsError
  
  Служба голосового чата прекратила получать пакеты от удаленного участника.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceUnableToConnectError
  
  Служба голосового чата была неспособна установить соединение с другим пользователем.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceRemoteParticipantHangupError
  
  Удаленный участник голосового чата остановил чат.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceInvalidCallIDError
  
  Служба голосового чата не распознавала идентификатор вызова.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceAudioUnavailableError
  
  Аудио аппаратные средства недоступны к службе голосового чата.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceUninitializedClientError
  
  Приложение не устанавливало клиент прежде, чем вызвать методы службы голосового чата.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceClientMissingRequiredMethodsError
  
  Служба голосового чата не считала ожидаемый метод определенным клиентом.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceRemoteParticipantBusyError
  
  Удаленный участник уже подключен к голосовому чату.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceRemoteParticipantCancelledError
  
  Удаленный участник попытался запустить голосовой чат, затем отмененный.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceRemoteParticipantResponseInvalidError
  
  Недопустимые данные были получены от удаленного участника.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceRemoteParticipantDeclinedInviteError
  
  Удаленный участник отклонил приглашение.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceMethodCurrentlyInvalidError
  
  Метод на службе голосового чата вызвали, когда не было позволено быть вызванным (например, пытаясь соединиться, когда служба голосового чата была уже соединена).
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceNetworkConfigurationError
  
  Служба голосового чата имела проблемы при доступе к сети.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceUnsupportedRemoteVersionError
  
  Другой участник выполняет различную версию службы голосового чата.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceOutOfMemoryError
  
  Служба голосового чата была неспособна выделить память, требуемую работать.
  
  Доступный в iOS 3.0 и позже.
- GKVoiceChatServiceInvalidParameterError
  
  Параметр имел нераспознанное значение.
  
  Доступный в iOS 3.0 и позже.
Оператор импорта

Objective C

@import GameKit;

Доступность

Доступный в iOS 3.0 и позже.
Осуждаемый в iOS 7.0.