<FMLiveSwitchIStream> Protocol Reference

Stream interface. More...

Instance Methods
(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...

Detailed Description

Stream interface.

Method Documentation

addOnDirectionChange:

- (void) addOnDirectionChange:

(FMLiveSwitchAction0 *)

value

Adds a handler that is raised when the signalling state changes.

Reimplemented in FMLiveSwitchStreamBase.

addOnStateChange:

- (void) addOnStateChange:

(FMLiveSwitchAction0 *)

value

Adds a handler that is raised when the stream state changes.

Reimplemented in FMLiveSwitchStreamBase.

changeDirectionWithNewDirection:

- (FMLiveSwitchError*) changeDirectionWithNewDirection:

(FMLiveSwitchStreamDirection)

newDirection

Changes this stream's direction.

Reimplemented in FMLiveSwitchStreamBase, and FMLiveSwitchMediaStreamBase.

direction

- (FMLiveSwitchStreamDirection) direction

Gets the current direction.

Reimplemented in FMLiveSwitchStreamBase, and FMLiveSwitchMediaStreamBase.

externalId

- (NSString*) externalId

Gets the external identifier.

Reimplemented in FMLiveSwitchStreamBase.

id

- (NSString*) id

Gets the identifier.

Reimplemented in FMLiveSwitchStreamBase.

label

- (NSString*) label

Gets a label that identifies this class.

Reimplemented in FMLiveSwitchStreamBase, and FMLiveSwitchMediaStreamBase.

localDirection

- (FMLiveSwitchStreamDirection) localDirection

Gets current direction indicated by the local description.

Reimplemented in FMLiveSwitchStreamBase, and FMLiveSwitchMediaStreamBase.

localReceive

- (bool) localReceive

Gets a value indicating whether receiving media is supported by the local peer on this stream.

Reimplemented in FMLiveSwitchStreamBase.

localSend

- (bool) localSend

Gets a value indicating whether sending media is supported by the local peer on this stream.

Reimplemented in FMLiveSwitchStreamBase.

mediaDescriptionId

- (NSString*) mediaDescriptionId

Gets the media description identifier.

Reimplemented in FMLiveSwitchStreamBase.

remoteDirection

- (FMLiveSwitchStreamDirection) remoteDirection

Gets the current direction indicated by the remote description.

Reimplemented in FMLiveSwitchStreamBase, and FMLiveSwitchMediaStreamBase.

remoteReceive

- (bool) remoteReceive

Gets a value indicating whether receiving media is supported by the local peer on this stream.

Returns false if the remote stream direction has not been received.

Reimplemented in FMLiveSwitchStreamBase.

remoteSend

- (bool) remoteSend

Gets a value indicating whether sending media is supported by the remote peer on this stream.

Returns false if the remote stream direction has not been received.

Reimplemented in FMLiveSwitchStreamBase.

removeOnDirectionChange:

- (void) removeOnDirectionChange:

(FMLiveSwitchAction0 *)

value

Removes a handler that is raised when the signalling state changes.

Reimplemented in FMLiveSwitchStreamBase.

removeOnStateChange:

- (void) removeOnStateChange:

(FMLiveSwitchAction0 *)

value

Removes a handler that is raised when the stream state changes.

Reimplemented in FMLiveSwitchStreamBase.

setExternalId:

- (void) setExternalId:

(NSString *)

value

Sets the external identifier.

Reimplemented in FMLiveSwitchStreamBase.

setLocalDirection:

- (void) setLocalDirection:

(FMLiveSwitchStreamDirection)

value

Sets current direction indicated by the local description.

Reimplemented in FMLiveSwitchStreamBase, and FMLiveSwitchMediaStreamBase.

setLocalReceive:

- (void) setLocalReceive:

(bool)

value

Sets a value indicating whether receiving media is supported by the local peer on this stream.

Reimplemented in FMLiveSwitchStreamBase.

setLocalSend:

- (void) setLocalSend:

(bool)

value

Sets a value indicating whether sending media is supported by the local peer on this stream.

Reimplemented in FMLiveSwitchStreamBase.

setTag:

- (void) setTag:

(NSString *)

value

Sets optional data to associate with this instance.

Reimplemented in FMLiveSwitchStreamBase.

state

- (FMLiveSwitchStreamState) state

Gets the current state.

Reimplemented in FMLiveSwitchStreamBase.

tag

- (NSString*) tag

Gets optional data to associate with this instance.

Reimplemented in FMLiveSwitchStreamBase.

transportInfo

- (FMLiveSwitchTransportInfo*) transportInfo

Gets the stream transport info.

Reimplemented in FMLiveSwitchStreamBase.

type

- (FMLiveSwitchStreamType) type

Gets the type.

Reimplemented in FMLiveSwitchStreamBase.