 |
LiveSwitch iOS/macOS API Reference Documentation
|
|
LiveSwitch iOS/macOS API Reference Documentation
|
Media stream interface. More...
Instance Methods | |
| (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... | |
Media stream interface.
| - (void) addOnDiscardBitrateNotification: | (FMLiveSwitchAction1 *) | value |
Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint.
| - (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.
| - (void) addOnDiscardBitrateNotificationWithBlock: | (void(^)(FMLiveSwitchBitrateNotification *)) | valueBlock |
Adds a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint.
| - (void) addOnDiscardBitrateRequest: | (FMLiveSwitchAction1 *) | value |
Adds a handler that is raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint.
| - (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.
| - (void) addOnDiscardBitrateRequestWithBlock: | (void(^)(FMLiveSwitchBitrateRequest *)) | valueBlock |
Adds a handler that is raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint.
| - (void) addOnLocalEncodingDisabled: | (FMLiveSwitchAction1 *) | value |
Adds a handler that is raised when a local encoding is disabled.
| - (FMLiveSwitchEncodingInfo*) addOnLocalEncodingDisabledWithBlock |
Adds a handler that is raised when a local encoding is disabled.
| - (void) addOnLocalEncodingDisabledWithBlock: | (void(^)(FMLiveSwitchEncodingInfo *)) | valueBlock |
Adds a handler that is raised when a local encoding is disabled.
| - (void) addOnLocalEncodingEnabled: | (FMLiveSwitchAction1 *) | value |
Adds a handler that is raised when a local encoding is enabled.
| - (FMLiveSwitchEncodingInfo*) addOnLocalEncodingEnabledWithBlock |
Adds a handler that is raised when a local encoding is enabled.
| - (void) addOnLocalEncodingEnabledWithBlock: | (void(^)(FMLiveSwitchEncodingInfo *)) | valueBlock |
Adds a handler that is raised when a local encoding is enabled.
| - (FMLiveSwitchStreamDirection) cachedLocalDirection |
Gets Cached Local Direction for this Media Stream.
Internal use.
| - (FMLiveSwitchTransportInfo*) controlTransportInfo |
Gets the media stream control transport info.
| - (bool) getCodecDisabledWithName: | (NSString *) | name |
Gets whether a codec is disabled.
| name | The codec name. |
| - (FMLiveSwitchMediaStreamInfo*) info |
Gets the media stream info.
| - (bool) inputMuted |
Gets whether the input track is muted.
| - (int) localBandwidth |
Gets the local bandwidth, in kbps.
This value is signalled in the local session description sent to the remote endpoint so it can limit its outbound media bitrate. Use FMLiveSwitchIMediaStream::maxReceiveBitrate to control inbound media bitrate once the session has been negotiated.
| - (NSString*) localCanonicalName |
Gets the local canonical name.
| - (int) maxReceiveBitrate |
Gets the maximum desired receive bitrate, in kbps.
This value must be less than or equal to FMLiveSwitchIMediaStream::localBandwidth.
| - (int) maxSendBitrate |
Gets the maximum desired send bitrate, in kbps.
This value must be less than or equal to FMLiveSwitchIMediaStream::remoteBandwidth.
| - (bool) outputMuted |
Gets whether the output track is muted.
| - (NSMutableArray*) preferredCodecs |
Gets any preferred codecs, in order of preference.
| - (bool) raiseBitrateNotification: | (FMLiveSwitchBitrateNotification *) | bitrateNotification |
Raises a bitrate notification to the remote track.
| bitrateNotification | The bitrate notification. |
| - (bool) raiseBitrateRequest: | (FMLiveSwitchBitrateRequest *) | bitrateRequest |
Raises a bitrate request to the local track.
| bitrateRequest | The bitrate request. |
| - (int) remoteBandwidth |
Gets the remote bandwidth, in kbps.
This value is signalled in the remote session description received from the remote endpoint so we can limit our outbound media bitrate. Use FMLiveSwitchIMediaStream::maxSendBitrate to control outbound media bitrate once the session has been negotiated.
| - (NSString*) remoteCanonicalName |
Gets the remote canonical name.
| - (FMLiveSwitchEncodingInfo*) remoteEncoding |
Gets the remote encoding.
| - (bool) remoteMuted |
Gets a value that indicates if remote is muted.
| - (bool) remoteRequestedDeactivation |
Gets Boolean value set when the server is currently requesting a 0 bitrate.
This is to highlight the difference between when a stream is deactivated locally or by a control mechanism on the server. Internal Use
| - (void) removeOnDiscardBitrateNotification: | (FMLiveSwitchAction1 *) | value |
Removes a handler that is raised when a bitrate notification is discarded due to policy restrictions or lack of support by the remote endpoint.
| - (void) removeOnDiscardBitrateRequest: | (FMLiveSwitchAction1 *) | value |
Removes a handler that is raised when a bitrate request is discarded due to policy restrictions or lack of support by the remote endpoint.
| - (void) removeOnLocalEncodingDisabled: | (FMLiveSwitchAction1 *) | value |
Removes a handler that is raised when a local encoding is disabled.
| - (void) removeOnLocalEncodingEnabled: | (FMLiveSwitchAction1 *) | value |
Removes a handler that is raised when a local encoding is enabled.
| - (void) setCodecDisabledWithName: | (NSString *) | name | |
| disabled: | (bool) | disabled | |
Sets whether a codec is disabled.
| name | The codec name. |
| disabled | Whether to disable the codec. |
| - (void) setInputMuted: | (bool) | value |
Sets whether the input track is muted.
| - (void) setLocalBandwidth: | (int) | value |
Sets the local bandwidth, in kbps.
This value is signalled in the local session description sent to the remote endpoint so it can limit its outbound media bitrate. Use FMLiveSwitchIMediaStream::maxReceiveBitrate to control inbound media bitrate once the session has been negotiated.
| - (void) setMaxReceiveBitrate: | (int) | value |
Sets the maximum desired receive bitrate, in kbps.
This value must be less than or equal to FMLiveSwitchIMediaStream::localBandwidth.
| - (void) setMaxSendBitrate: | (int) | value |
Sets the maximum desired send bitrate, in kbps.
This value must be less than or equal to FMLiveSwitchIMediaStream::remoteBandwidth.
| - (void) setOutputMuted: | (bool) | value |
Sets whether the output track is muted.
| - (void) setPreferredCodecs: | (NSMutableArray *) | value |
Sets any preferred codecs, in order of preference.
| - (void) setRemoteEncoding: | (FMLiveSwitchEncodingInfo *) | value |
Sets the remote encoding.
| - (void) setRemoteMuted: | (bool) | value |
Sets a value that indicates if remote is muted.
| - (void) setSimulcastMode: | (FMLiveSwitchSimulcastMode) | value |
Sets the simulcast mode.
| - (FMLiveSwitchSimulcastMode) simulcastMode |
Gets the simulcast mode.