FMLiveSwitchStream Class Reference

A peer-to-peer stream. More...

Instance Methods

(void) - addOnDisabledChange:
 Adds a handler that is raised when the Disabled property changes state. More...
 
(bool) - deactivated
 Gets a value indicating whether this stream is deactivated. More...
 
(bool) - disabled
 Gets a value indicating whether this stream is disabled. More...
 
(FMLiveSwitchEncryptionMode) - encryptionMode
 Gets the encryption mode. More...
 
(NSMutableArray *) - encryptionModes
 Gets the encryption modes. More...
 
(FMLiveSwitchEncryptionPolicy) - encryptionPolicy
 Gets a value indicating Encryption Policy. More...
 
(int) - index
 Gets the index. More...
 
(instancetype) - initWithType:
 Initializes a new instance of the FMLiveSwitchStream class. More...
 
(FMLiveSwitchIceParameters *) - localIceParameters
 Gets the local ICE parameters. More...
 
(void) - raiseDisabledChange
 Raises the OnDisabledChange event. More...
 
(FMLiveSwitchIceParameters *) - remoteIceParameters
 Gets the remote ICE parameters. More...
 
(void) - removeOnDisabledChange:
 Removes a handler that is raised when the Disabled property changes state. More...
 
(FMLiveSwitchSdesPolicy) - sdesPolicy
 Gets Sdes policy for stream. More...
 
(void) - setDeactivated:
 Sets a value indicating whether this stream is deactivated. More...
 
(void) - setDisabled:
 Sets a value indicating whether this stream is disabled. More...
 
(void) - setEncryptionMode:
 Sets the encryption mode. More...
 
(void) - setEncryptionModes:
 Sets the encryption modes. More...
 
(void) - setEncryptionPolicy:
 Sets a value indicating Encryption Policy. More...
 
(void) - setSdesPolicy:
 Sets Sdes policy for stream. More...
 
(void) - setUseDtls:
 Sets a value indicating whether DTLS encryption is in use for this stream. More...
 
(void) - setUseSdes:
 Sets a value indicating whether SDES encryption is in use for this stream. More...
 
(bool) - useDtls
 Gets a value indicating whether DTLS encryption is in use for this stream. More...
 
(bool) - useSdes
 Gets a value indicating whether SDES encryption is in use for this stream. More...
 
- Instance Methods inherited from FMLiveSwitchStreamBase
(void) - addOnDirectionChange:
 Adds a handler that is raised when the stream direction changes. More...
 
(void) - addOnStateChange:
 Adds a handler that is raised when the connection state changes. More...
 
(FMLiveSwitchError *) - changeDirectionWithNewDirection:
 Changes this stream's direction. More...
 
(long long) - connectedTimestamp
 Gets the ManagedStopwatch.GetTimestamp() value representing the ticks that passed when this stream's connection state changed to connected. More...
 
(NSString *) - connectionId
 Gets the connection identifier. More...
 
(NSString *) - description
 Returns a string that represents this instance. More...
 
(FMLiveSwitchStreamDirection) - direction
 Gets the current direction. More...
 
(NSString *) - externalId
 Gets the external identifier. More...
 
(NSString *) - id
 Gets the identifier. More...
 
(bool) - isTerminated
 Gets a value indicating whether the stream is currently closed or failed. More...
 
(bool) - isTerminating
 Gets a value indicating whether the stream is currently closing or failing. More...
 
(bool) - isTerminatingOrTerminated
 Gets a value indicating whether the stream is currently closing, failing, closed, or failed. 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 the local peer supports receiving media on this stream. More...
 
(bool) - localSend
 Gets a value indicating whether the local peer on this stream supports sending media on this stream. More...
 
(NSString *) - mediaDescriptionId
 Gets the media description ID of this stream. More...
 
(void) - processStateChange
 Processes a state change. More...
 
(void) - processStateLockChange
 Processes a state lock change. More...
 
(FMLiveSwitchStreamDirection) - remoteDirection
 Gets current direction indicated by the remote description. More...
 
(bool) - remoteReceive
 Gets a value indicating whether receiving media is supported by the remote 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 stream direction changes. More...
 
(void) - removeOnStateChange:
 Removes a handler that is raised when the connection 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 the local peer supports receiving media on this stream. More...
 
(void) - setLocalSend:
 Sets a value indicating whether the local peer on this stream supports sending media on this stream. More...
 
(void) - setTag:
 Sets optional data to associate with this instance. More...
 
(FMLiveSwitchStreamState) - state
 Gets the state of the stream. 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...
 
- Instance Methods inherited from FMLiveSwitchDynamic
(NSMutableDictionary< NSString *, id > *) - dynamicProperties
 Gets all dynamic properties on this instance. More...
 
(id- getDynamicValueWithKey:
 Gets a property value from the local cache. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchSerializable class. More...
 
(void) - setDynamicValueWithKey:value:
 Sets a property value in the local cache. More...
 
(bool) - unsetDynamicValueWithKey:
 Removes a property value from the local cache. More...
 

Class Methods

(FMLiveSwitchStream *) + streamWithType:
 Initializes a new instance of the FMLiveSwitchStream class. More...
 
- Class Methods inherited from FMLiveSwitchStreamBase
(FMLiveSwitchStreamBase *) + streamBaseWithType:
 Initializes a new instance of the FMLiveSwitchStreamBase class. More...
 
- Class Methods inherited from FMLiveSwitchDynamic
(FMLiveSwitchDynamic *) + dynamic
 
- Class Methods inherited from FMLiveSwitchSerializable
(FMLiveSwitchSerializable *) + serializable
 Initializes a new instance of the FMLiveSwitchSerializable class. More...
 

Detailed Description

A peer-to-peer stream.

Method Documentation

◆ addOnDisabledChange:

- (void) addOnDisabledChange: (FMLiveSwitchAction0 *)  value

Adds a handler that is raised when the Disabled property changes state.

◆ deactivated

- (bool) deactivated

Gets a value indicating whether this stream is deactivated.

A stream is deactivated if its direction is unset or inactive.

◆ disabled

- (bool) disabled

Gets a value indicating whether this stream is disabled.

A stream is disabled if session negotiation failed or if the underlying transport could not be started.

◆ encryptionMode

- (FMLiveSwitchEncryptionMode) encryptionMode

Gets the encryption mode.

◆ encryptionModes

- (NSMutableArray*) encryptionModes

Gets the encryption modes.

◆ encryptionPolicy

- (FMLiveSwitchEncryptionPolicy) encryptionPolicy

Gets a value indicating Encryption Policy.

◆ index

- (int) index

Gets the index.

◆ initWithType:

- (instancetype) initWithType: (FMLiveSwitchStreamType)  type

Initializes a new instance of the FMLiveSwitchStream class.

Parameters
typeThe type.

Implements FMLiveSwitchStreamBase.

Implemented in FMLiveSwitchMediaStreamBase.

◆ localIceParameters

- (FMLiveSwitchIceParameters*) localIceParameters

Gets the local ICE parameters.

◆ raiseDisabledChange

- (void) raiseDisabledChange

Raises the OnDisabledChange event.

◆ remoteIceParameters

- (FMLiveSwitchIceParameters*) remoteIceParameters

Gets the remote ICE parameters.

◆ removeOnDisabledChange:

- (void) removeOnDisabledChange: (FMLiveSwitchAction0 *)  value

Removes a handler that is raised when the Disabled property changes state.

◆ sdesPolicy

- (FMLiveSwitchSdesPolicy) sdesPolicy

Gets Sdes policy for stream.

◆ setDeactivated:

- (void) setDeactivated: (bool)  value

Sets a value indicating whether this stream is deactivated.

A stream is deactivated if its direction is unset or inactive.

◆ setDisabled:

- (void) setDisabled: (bool)  value

Sets a value indicating whether this stream is disabled.

A stream is disabled if session negotiation failed or if the underlying transport could not be started.

◆ setEncryptionMode:

- (void) setEncryptionMode: (FMLiveSwitchEncryptionMode)  value

Sets the encryption mode.

◆ setEncryptionModes:

- (void) setEncryptionModes: (NSMutableArray *)  value

Sets the encryption modes.

◆ setEncryptionPolicy:

- (void) setEncryptionPolicy: (FMLiveSwitchEncryptionPolicy)  value

Sets a value indicating Encryption Policy.

◆ setSdesPolicy:

- (void) setSdesPolicy: (FMLiveSwitchSdesPolicy)  value

Sets Sdes policy for stream.

◆ setUseDtls:

- (void) setUseDtls: (bool)  value

Sets a value indicating whether DTLS encryption is in use for this stream.

◆ setUseSdes:

- (void) setUseSdes: (bool)  value

Sets a value indicating whether SDES encryption is in use for this stream.

◆ streamWithType:

+ (FMLiveSwitchStream*) streamWithType: (FMLiveSwitchStreamType)  type

Initializes a new instance of the FMLiveSwitchStream class.

Parameters
typeThe type.

◆ useDtls

- (bool) useDtls

Gets a value indicating whether DTLS encryption is in use for this stream.

◆ useSdes

- (bool) useSdes

Gets a value indicating whether SDES encryption is in use for this stream.