 |
LiveSwitch iOS/macOS API Reference Documentation
|
|
LiveSwitch iOS/macOS API Reference Documentation
|
Audio stream interface. More...
Instance Methods | |
| (void) | - addOnReceiveDtmfTone: |
| Adds a handler that is raised when a DTMF tone is received. More... | |
| (void) | - addOnReceiveDtmfToneChange: |
| Adds a handler that is raised when the received DTMF tone changes. More... | |
| (FMLiveSwitchDtmfTone *) | - addOnReceiveDtmfToneChangeWithBlock |
| Adds a handler that is raised when the received DTMF tone changes. More... | |
| (void) | - addOnReceiveDtmfToneChangeWithBlock: |
| Adds a handler that is raised when the received DTMF tone changes. More... | |
| (FMLiveSwitchDtmfTone *) | - addOnReceiveDtmfToneWithBlock |
| Adds a handler that is raised when a DTMF tone is received. More... | |
| (void) | - addOnReceiveDtmfToneWithBlock: |
| Adds a handler that is raised when a DTMF tone is received. More... | |
| (void) | - addOnSendDtmfTone: |
| Adds a handler that is raised when a DTMF tone is sent. More... | |
| (void) | - addOnSendDtmfToneChange: |
| Adds a handler that is raised when the sent DTMF tone changes. More... | |
| (FMLiveSwitchDtmfTone *) | - addOnSendDtmfToneChangeWithBlock |
| Adds a handler that is raised when the sent DTMF tone changes. More... | |
| (void) | - addOnSendDtmfToneChangeWithBlock: |
| Adds a handler that is raised when the sent DTMF tone changes. More... | |
| (FMLiveSwitchDtmfTone *) | - addOnSendDtmfToneWithBlock |
| Adds a handler that is raised when a DTMF tone is sent. More... | |
| (void) | - addOnSendDtmfToneWithBlock: |
| Adds a handler that is raised when a DTMF tone is sent. More... | |
| (bool) | - g722Disabled |
| Gets whether G.722 is disabled. More... | |
| (bool) | - insertDtmfTone: |
| Inserts a DTMF tone. More... | |
| (bool) | - insertDtmfTones: |
| Inserts DTMF tones. More... | |
| (bool) | - opusDisabled |
| Gets whether Opus is disabled. More... | |
| (bool) | - pcmaDisabled |
| Gets whether PCMA is disabled. More... | |
| (bool) | - pcmuDisabled |
| Gets whether PCMU is disabled. More... | |
| (void) | - removeOnReceiveDtmfTone: |
| Removes a handler that is raised when a DTMF tone is received. More... | |
| (void) | - removeOnReceiveDtmfToneChange: |
| Removes a handler that is raised when the received DTMF tone changes. More... | |
| (void) | - removeOnSendDtmfTone: |
| Removes a handler that is raised when a DTMF tone is sent. More... | |
| (void) | - removeOnSendDtmfToneChange: |
| Removes a handler that is raised when the sent DTMF tone changes. More... | |
| (void) | - setG722Disabled: |
| Sets whether G.722 is disabled. More... | |
| (void) | - setOpusDisabled: |
| Sets whether Opus is disabled. More... | |
| (void) | - setPcmaDisabled: |
| Sets whether PCMA is disabled. More... | |
| (void) | - setPcmuDisabled: |
| Sets whether PCMU is disabled. More... | |
 Instance Methods inherited from <FMLiveSwitchIMediaStream> | |
| (void) | - addOnDiscardBitrateNotification: |
| Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint. More... | |
| (FMLiveSwitchBitrateNotification *) | - addOnDiscardBitrateNotificationWithBlock |
| Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint. More... | |
| (void) | - addOnDiscardBitrateNotificationWithBlock: |
| Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint. More... | |
| (void) | - addOnDiscardBitrateRequest: |
| Adds a handler that is raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint. More... | |
| (FMLiveSwitchBitrateRequest *) | - addOnDiscardBitrateRequestWithBlock |
| Adds a handler that is raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint. More... | |
| (void) | - addOnDiscardBitrateRequestWithBlock: |
| Adds a handler that is raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint. More... | |
| (void) | - addOnLocalEncodingDisabled: |
| Adds a handler that is raised when a local encoding is disabled. More... | |
| (FMLiveSwitchEncodingInfo *) | - addOnLocalEncodingDisabledWithBlock |
| Adds a handler that is raised when a local encoding is disabled. More... | |
| (void) | - addOnLocalEncodingDisabledWithBlock: |
| Adds a handler that is raised when a local encoding is disabled. More... | |
| (void) | - addOnLocalEncodingEnabled: |
| Adds a handler that is raised when a local encoding is enabled. More... | |
| (FMLiveSwitchEncodingInfo *) | - addOnLocalEncodingEnabledWithBlock |
| Adds a handler that is raised when a local encoding is enabled. More... | |
| (void) | - addOnLocalEncodingEnabledWithBlock: |
| Adds a handler that is raised when a local encoding is enabled. More... | |
| (FMLiveSwitchStreamDirection) | - cachedLocalDirection |
| Gets Cached Local Direction for this Media Stream. More... | |
| (FMLiveSwitchTransportInfo *) | - controlTransportInfo |
| Gets the media stream control transport info. More... | |
| (bool) | - getCodecDisabledWithName: |
| Gets whether a codec is disabled. More... | |
| (FMLiveSwitchMediaStreamInfo *) | - info |
| Gets the media stream info. More... | |
| (bool) | - inputMuted |
| Gets whether the input track is muted. More... | |
| (int) | - localBandwidth |
| Gets the local bandwidth, in kbps. More... | |
| (NSString *) | - localCanonicalName |
| Gets the local canonical name. More... | |
| (int) | - maxReceiveBitrate |
| Gets the maximum desired receive bitrate, in kbps. More... | |
| (int) | - maxSendBitrate |
| Gets the maximum desired send bitrate, in kbps. More... | |
| (bool) | - outputMuted |
| Gets whether the output track is muted. More... | |
| (NSMutableArray *) | - preferredCodecs |
| Gets any preferred codecs, in order of preference. More... | |
| (bool) | - raiseBitrateNotification: |
| Raises a bitrate notification to the remote track. More... | |
| (bool) | - raiseBitrateRequest: |
| Raises a bitrate request to the local track. More... | |
| (int) | - remoteBandwidth |
| Gets the remote bandwidth, in kbps. More... | |
| (NSString *) | - remoteCanonicalName |
| Gets the remote canonical name. More... | |
| (FMLiveSwitchEncodingInfo *) | - remoteEncoding |
| Gets the remote encoding. More... | |
| (bool) | - remoteMuted |
| Gets a value that indicates if remote is muted. More... | |
| (bool) | - remoteRequestedDeactivation |
| Gets Boolean value set when the server is currently requesting a 0 bitrate. More... | |
| (void) | - removeOnDiscardBitrateNotification: |
| Removes a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint. More... | |
| (void) | - removeOnDiscardBitrateRequest: |
| Removes a handler that is raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint. More... | |
| (void) | - removeOnLocalEncodingDisabled: |
| Removes a handler that is raised when a local encoding is disabled. More... | |
| (void) | - removeOnLocalEncodingEnabled: |
| Removes a handler that is raised when a local encoding is enabled. More... | |
| (void) | - setCodecDisabledWithName:disabled: |
| Sets whether a codec is disabled. More... | |
| (void) | - setInputMuted: |
| Sets whether the input track is muted. More... | |
| (void) | - setLocalBandwidth: |
| Sets the local bandwidth, in kbps. More... | |
| (void) | - setMaxReceiveBitrate: |
| Sets the maximum desired receive bitrate, in kbps. More... | |
| (void) | - setMaxSendBitrate: |
| Sets the maximum desired send bitrate, in kbps. More... | |
| (void) | - setOutputMuted: |
| Sets whether the output track is muted. More... | |
| (void) | - setPreferredCodecs: |
| Sets any preferred codecs, in order of preference. More... | |
| (void) | - setRemoteEncoding: |
| Sets the remote encoding. More... | |
| (void) | - setRemoteMuted: |
| Sets a value that indicates if remote is muted. More... | |
| (void) | - setSimulcastMode: |
| Sets the simulcast mode. More... | |
| (FMLiveSwitchSimulcastMode) | - simulcastMode |
| Gets the simulcast mode. More... | |
| Instance Methods inherited from <FMLiveSwitchIStream> | |
| (void) | - addOnDirectionChange: |
| Adds a handler that is raised when the signalling state changes. More... | |
| (void) | - addOnStateChange: |
| Adds a handler that is raised when the stream state changes. More... | |
| (FMLiveSwitchError *) | - changeDirectionWithNewDirection: |
| Changes this stream's direction. More... | |
| (FMLiveSwitchStreamDirection) | - direction |
| Gets the current direction. More... | |
| (NSString *) | - externalId |
| Gets the external identifier. More... | |
| (NSString *) | - id |
| Gets the identifier. More... | |
| (NSString *) | - label |
| Gets a label that identifies this class. More... | |
| (FMLiveSwitchStreamDirection) | - localDirection |
| Gets current direction indicated by the local description. More... | |
| (bool) | - localReceive |
| Gets a value indicating whether receiving media is supported by the local peer on this stream. More... | |
| (bool) | - localSend |
| Gets a value indicating whether sending media is supported by the local peer on this stream. More... | |
| (NSString *) | - mediaDescriptionId |
| Gets the media description identifier. More... | |
| (FMLiveSwitchStreamDirection) | - remoteDirection |
| Gets the current direction indicated by the remote description. More... | |
| (bool) | - remoteReceive |
| Gets a value indicating whether receiving media is supported by the local peer on this stream. More... | |
| (bool) | - remoteSend |
| Gets a value indicating whether sending media is supported by the remote peer on this stream. More... | |
| (void) | - removeOnDirectionChange: |
| Removes a handler that is raised when the signalling state changes. More... | |
| (void) | - removeOnStateChange: |
| Removes a handler that is raised when the stream state changes. More... | |
| (void) | - setExternalId: |
| Sets the external identifier. More... | |
| (void) | - setLocalDirection: |
| Sets current direction indicated by the local description. More... | |
| (void) | - setLocalReceive: |
| Sets a value indicating whether receiving media is supported by the local peer on this stream. More... | |
| (void) | - setLocalSend: |
| Sets a value indicating whether sending media is supported by the local peer on this stream. More... | |
| (void) | - setTag: |
| Sets optional data to associate with this instance. More... | |
| (FMLiveSwitchStreamState) | - state |
| Gets the current state. More... | |
| (NSString *) | - tag |
| Gets optional data to associate with this instance. More... | |
| (FMLiveSwitchTransportInfo *) | - transportInfo |
| Gets the stream transport info. More... | |
| (FMLiveSwitchStreamType) | - type |
| Gets the type. More... | |
Audio stream interface.
| - (void) addOnReceiveDtmfTone: | (FMLiveSwitchAction1 *) | value |
Adds a handler that is raised when a DTMF tone is received.
| - (void) addOnReceiveDtmfToneChange: | (FMLiveSwitchAction1 *) | value |
Adds a handler that is raised when the received DTMF tone changes.
| - (FMLiveSwitchDtmfTone*) addOnReceiveDtmfToneChangeWithBlock |
Adds a handler that is raised when the received DTMF tone changes.
| - (void) addOnReceiveDtmfToneChangeWithBlock: | (void(^)(FMLiveSwitchDtmfTone *)) | valueBlock |
Adds a handler that is raised when the received DTMF tone changes.
| - (FMLiveSwitchDtmfTone*) addOnReceiveDtmfToneWithBlock |
Adds a handler that is raised when a DTMF tone is received.
| - (void) addOnReceiveDtmfToneWithBlock: | (void(^)(FMLiveSwitchDtmfTone *)) | valueBlock |
Adds a handler that is raised when a DTMF tone is received.
| - (void) addOnSendDtmfTone: | (FMLiveSwitchAction1 *) | value |
Adds a handler that is raised when a DTMF tone is sent.
| - (void) addOnSendDtmfToneChange: | (FMLiveSwitchAction1 *) | value |
Adds a handler that is raised when the sent DTMF tone changes.
| - (FMLiveSwitchDtmfTone*) addOnSendDtmfToneChangeWithBlock |
Adds a handler that is raised when the sent DTMF tone changes.
| - (void) addOnSendDtmfToneChangeWithBlock: | (void(^)(FMLiveSwitchDtmfTone *)) | valueBlock |
Adds a handler that is raised when the sent DTMF tone changes.
| - (FMLiveSwitchDtmfTone*) addOnSendDtmfToneWithBlock |
Adds a handler that is raised when a DTMF tone is sent.
| - (void) addOnSendDtmfToneWithBlock: | (void(^)(FMLiveSwitchDtmfTone *)) | valueBlock |
Adds a handler that is raised when a DTMF tone is sent.
| - (bool) g722Disabled |
Gets whether G.722 is disabled.
| - (bool) insertDtmfTone: | (FMLiveSwitchDtmfTone *) | dtmfTone |
Inserts a DTMF tone.
| dtmfTone | The DTMF tone. |
| - (bool) insertDtmfTones: | (NSMutableArray *) | dtmfTones |
Inserts DTMF tones.
| dtmfTones | The DTMF tones. |
| - (bool) opusDisabled |
Gets whether Opus is disabled.
| - (bool) pcmaDisabled |
Gets whether PCMA is disabled.
| - (bool) pcmuDisabled |
Gets whether PCMU is disabled.
| - (void) removeOnReceiveDtmfTone: | (FMLiveSwitchAction1 *) | value |
Removes a handler that is raised when a DTMF tone is received.
| - (void) removeOnReceiveDtmfToneChange: | (FMLiveSwitchAction1 *) | value |
Removes a handler that is raised when the received DTMF tone changes.
| - (void) removeOnSendDtmfTone: | (FMLiveSwitchAction1 *) | value |
Removes a handler that is raised when a DTMF tone is sent.
| - (void) removeOnSendDtmfToneChange: | (FMLiveSwitchAction1 *) | value |
Removes a handler that is raised when the sent DTMF tone changes.
| - (void) setG722Disabled: | (bool) | value |
Sets whether G.722 is disabled.
| - (void) setOpusDisabled: | (bool) | value |
Sets whether Opus is disabled.
| - (void) setPcmaDisabled: | (bool) | value |
Sets whether PCMA is disabled.
| - (void) setPcmuDisabled: | (bool) | value |
Sets whether PCMU is disabled.