FMLiveSwitchSessionDescription Class Reference

A session description. More...

Instance Methods

(bool) - hasAudio
 Gets a value indicating whether an audio stream is described. More...
 
(bool) - hasData
 Gets a value indicating whether a data stream is described. More...
 
(bool) - hasVideo
 Gets a value indicating whether a video stream is described. More...
 
(instancetype) - init
 
(bool) - isOffer
 Gets a value indicating whether this instance is offer. More...
 
(FMLiveSwitchSdpMessage *) - sdpMessage
 Gets the SDP message. More...
 
(long long) - sessionId
 Gets the session id of the remote description, if remote description is set. More...
 
(long long) - sessionVersion
 Gets the version of the remote description, if remote description is set. More...
 
(void) - setSdpMessage:
 Sets the SDP message. More...
 
(void) - setSessionVersion:
 Sets the version of the remote description, if remote description is set. More...
 
(void) - setTieBreaker:
 Sets the tie breaker in case of a role conflict. More...
 
(void) - setType:
 Sets the type. More...
 
(NSString *) - tieBreaker
 Gets the tie breaker in case of a role conflict. More...
 
(NSString *) - toJson
 Serializes this instance to JSON. More...
 
(FMLiveSwitchSessionDescriptionType) - type
 Gets the type. More...
 

Class Methods

(FMLiveSwitchSessionDescription *) + fromJsonWithSessionDescriptionJson:
 Deserializes an instance from JSON. More...
 
(FMLiveSwitchSessionDescription *) + sessionDescription
 
(NSString *) + toJsonWithSessionDescription:
 Serializes an instance to JSON. More...
 

Detailed Description

A session description.

Method Documentation

◆ fromJsonWithSessionDescriptionJson:

+ (FMLiveSwitchSessionDescription*) fromJsonWithSessionDescriptionJson: (NSString *)  sessionDescriptionJson

Deserializes an instance from JSON.

Parameters
sessionDescriptionJsonThe JSON to deserialize.
Returns
The deserialized session description.

◆ hasAudio

- (bool) hasAudio

Gets a value indicating whether an audio stream is described.

◆ hasData

- (bool) hasData

Gets a value indicating whether a data stream is described.

◆ hasVideo

- (bool) hasVideo

Gets a value indicating whether a video stream is described.

◆ init

- (instancetype) init

◆ isOffer

- (bool) isOffer

Gets a value indicating whether this instance is offer.

◆ sdpMessage

- (FMLiveSwitchSdpMessage*) sdpMessage

Gets the SDP message.

◆ sessionDescription

+ (FMLiveSwitchSessionDescription*) sessionDescription

◆ sessionId

- (long long) sessionId

Gets the session id of the remote description, if remote description is set.

Returns null otherwise.

◆ sessionVersion

- (long long) sessionVersion

Gets the version of the remote description, if remote description is set.

Returns null otherwise.

◆ setSdpMessage:

- (void) setSdpMessage: (FMLiveSwitchSdpMessage *)  value

Sets the SDP message.

◆ setSessionVersion:

- (void) setSessionVersion: (long long)  value

Sets the version of the remote description, if remote description is set.

Returns null otherwise.

◆ setTieBreaker:

- (void) setTieBreaker: (NSString *)  value

Sets the tie breaker in case of a role conflict.

◆ setType:

- (void) setType: (FMLiveSwitchSessionDescriptionType)  value

Sets the type.

◆ tieBreaker

- (NSString*) tieBreaker

Gets the tie breaker in case of a role conflict.

◆ toJson

- (NSString*) toJson

Serializes this instance to JSON.

◆ toJsonWithSessionDescription:

+ (NSString*) toJsonWithSessionDescription: (FMLiveSwitchSessionDescription *)  sessionDescription

Serializes an instance to JSON.

Parameters
sessionDescriptionThe session description.
Returns
The serialized JSON.

◆ type

- (FMLiveSwitchSessionDescriptionType) type

Gets the type.