FMLiveSwitchSdpInactiveAttribute Class Reference

This specifies that the tools should be started in inactive mode. More...

Instance Methods

(NSString *) - getAttributeValue
 Gets the internal value of the attribute. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchSdpInactiveAttribute class. More...
 
(FMLiveSwitchStreamDirection) - streamDirection
 Gets the stream direction. More...
 
- Instance Methods inherited from FMLiveSwitchSdpAttribute
(FMLiveSwitchSdpAttributeType) - attributeType
 Gets this Attribute's Type. More...
 
(NSString *) - description
 Converts this instance to a string. More...
 
(FMLiveSwitchSdpAttributeCategory) - multiplexingCategory
 Gets the Multiplexing Category of this Attribute. More...
 
(void) - setAttributeType:
 Sets this Attribute's Type. More...
 
(void) - setMultiplexingCategory:
 Sets the Multiplexing Category of this Attribute. More...
 

Class Methods

(FMLiveSwitchSdpInactiveAttribute *) + fromAttributeValue:
 Initializes a new instance of the FMLiveSwitchSdpInactiveAttribute class. More...
 
(FMLiveSwitchSdpInactiveAttribute *) + inactiveAttribute
 Initializes a new instance of the FMLiveSwitchSdpInactiveAttribute class. More...
 
- Class Methods inherited from FMLiveSwitchSdpDirectionAttribute
(FMLiveSwitchSdpDirectionAttribute *) + directionAttribute
 
(FMLiveSwitchSdpDirectionAttribute *) + generateDirectionAttributeWithDirection:
 Creates a DirectionAttribute for a required direction. More...
 
- Class Methods inherited from FMLiveSwitchSdpAttribute
(FMLiveSwitchSdpAttribute *) + attribute
 
(FMLiveSwitchSdpAttribute *) + createAttributeWithName:value:
 Creates an attribute. More...
 
(NSString *) + getTypeNameWithType:
 Gets the name of the attribute type. More...
 
(bool) + isMediaLevelWithType:
 Determines whether the type applies to media streams. More...
 
(bool) + isSessionLevelWithType:
 Determines whether the type applies to sessions. More...
 
(FMLiveSwitchSdpAttribute *) + parseWithS:
 Creates an FMLiveSwitchSdpConnectionData instance from a string. More...
 

Detailed Description

This specifies that the tools should be started in inactive mode.

This is necessary for interactive conferences where users can put other users on hold. No media is sent over an inactive media stream. Note that an RTP-based system SHOULD still send RTCP, even if started inactive. It can be either a session or media-level attribute, and it is not dependent on charset.

Method Documentation

◆ fromAttributeValue:

+ (FMLiveSwitchSdpInactiveAttribute*) fromAttributeValue: (NSString *)  value

Initializes a new instance of the FMLiveSwitchSdpInactiveAttribute class.

Parameters
valueThe attribute value.

◆ getAttributeValue

- (NSString*) getAttributeValue

Gets the internal value of the attribute.

Implements FMLiveSwitchSdpAttribute.

◆ inactiveAttribute

+ (FMLiveSwitchSdpInactiveAttribute*) inactiveAttribute

Initializes a new instance of the FMLiveSwitchSdpInactiveAttribute class.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchSdpInactiveAttribute class.

Implements FMLiveSwitchSdpDirectionAttribute.

◆ streamDirection

- (FMLiveSwitchStreamDirection) streamDirection

Gets the stream direction.

Implements FMLiveSwitchSdpDirectionAttribute.