FMLiveSwitchAppControlFrame Class Reference

An RTCP APP packet. More...

Instance Methods

(FMLiveSwitchDataBuffer *) - data
 Gets optional application-dependent data. More...
 
(int) - dataLength
 Gets the length of the data. More...
 
(int) - dataPayloadOffset
 Gets the offset of the data in the payload. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchAppControlFrame class. More...
 
(instancetype) - initWithBuffer:
 Initializes a new instance of the FMLiveSwitchAppControlFrame class. More...
 
(instancetype) - initWithSubType:synchronizationSource:name:data:
 Initializes a new instance of the FMLiveSwitchAppControlFrame class. More...
 
(NSString *) - name
 Gets the name. More...
 
(void) - setName:
 Sets the name. More...
 
(void) - setSubType:
 Sets the subtype to allow a set of APP packets to be defined under one unique name, or for any application-dependent data. More...
 
(void) - setSynchronizationSource:
 Sets the synchronization source. More...
 
(int) - subType
 Gets the subtype to allow a set of APP packets to be defined under one unique name, or for any application-dependent data. More...
 
(long long) - synchronizationSource
 Gets the synchronization source. More...
 
- Instance Methods inherited from FMLiveSwitchMediaControlFrame
(int) - byte1Last5Bits
 Gets the last 5 bits of the first byte. More...
 
(FMLiveSwitchDataBuffer *) - dataBuffer
 Gets the buffer. More...
 
(FMLiveSwitchDataBuffer *) - payload
 Gets the payload. More...
 
(int) - payloadLengthWithPadding
 Gets the length of the payload, in bytes, with padding. More...
 
(int) - payloadType
 Gets the payload type. More...
 
(void) - setByte1Last5Bits:
 Sets the last 5 bits of the first byte. More...
 
(void) - setDataBuffer:
 Sets the buffer. More...
 
(void) - setPayloadLengthWithPadding:
 Sets the length of the payload, in bytes, with padding. More...
 
(void) - setPayloadType:
 Sets the payload type. More...
 
(void) - setVersion:
 Sets the version. More...
 
(NSString *) - streamId
 Gets the stream ID. More...
 
(int) - version
 Gets the version. 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...
 
(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

(FMLiveSwitchAppControlFrame *) + appControlFrame
 Initializes a new instance of the FMLiveSwitchAppControlFrame class. More...
 
(FMLiveSwitchAppControlFrame *) + appControlFrameWithBuffer:
 Initializes a new instance of the FMLiveSwitchAppControlFrame class. More...
 
(FMLiveSwitchAppControlFrame *) + appControlFrameWithSubType:synchronizationSource:name:data:
 Initializes a new instance of the FMLiveSwitchAppControlFrame class. More...
 
(int) + fixedPayloadHeaderLength
 Gets the length of the fixed payload header. More...
 
(int) + registeredPayloadType
 Gets the application-specific payload type. More...
 
- Class Methods inherited from FMLiveSwitchMediaControlFrame
(NSMutableArray *) + addControlFrames:addControlFrames:index:
 Adds control frames to an array. More...
 
(NSMutableArray *) + addControlFrameWithControlFrames:addControlFrame:index:
 Adds a control frame to an array. More...
 
(int) + fixedHeaderLength
 Gets the length of the fixed header. More...
 
(FMLiveSwitchMediaControlFrame *) + mediaControlFrame
 Initializes a new instance of the FMLiveSwitchMediaControlFrame class. More...
 
(FMLiveSwitchMediaControlFrame *) + mediaControlFrameWithBuffer:
 Initializes a new instance of the FMLiveSwitchMediaControlFrame class. More...
 
(NSMutableArray *) + parseWithDataBuffer:
 Parses a data buffer into an array of control frames. More...
 
(NSMutableArray *) + removeControlFrameWithControlFrames:index:
 Removes a control frame from an array. 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

An RTCP APP packet.

Method Documentation

◆ appControlFrame

+ (FMLiveSwitchAppControlFrame*) appControlFrame

Initializes a new instance of the FMLiveSwitchAppControlFrame class.

◆ appControlFrameWithBuffer:

+ (FMLiveSwitchAppControlFrame*) appControlFrameWithBuffer: (FMLiveSwitchDataBuffer *)  buffer

Initializes a new instance of the FMLiveSwitchAppControlFrame class.

Parameters
bufferThe buffer.

◆ appControlFrameWithSubType:synchronizationSource:name:data:

+ (FMLiveSwitchAppControlFrame*) appControlFrameWithSubType: (int)  subType
synchronizationSource: (long long)  synchronizationSource
name: (NSString *)  name
data: (FMLiveSwitchDataBuffer *)  data 

Initializes a new instance of the FMLiveSwitchAppControlFrame class.

Parameters
subTypeType of the sub.
synchronizationSourceThe SSRC.
nameThe name.
dataThe data.

◆ data

Gets optional application-dependent data.

◆ dataLength

- (int) dataLength

Gets the length of the data.

◆ dataPayloadOffset

- (int) dataPayloadOffset

Gets the offset of the data in the payload.

◆ fixedPayloadHeaderLength

+ (int) fixedPayloadHeaderLength

Gets the length of the fixed payload header.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchAppControlFrame class.

Implements FMLiveSwitchMediaControlFrame.

◆ initWithBuffer:

- (instancetype) initWithBuffer: (FMLiveSwitchDataBuffer *)  buffer

Initializes a new instance of the FMLiveSwitchAppControlFrame class.

Parameters
bufferThe buffer.

Implements FMLiveSwitchMediaControlFrame.

◆ initWithSubType:synchronizationSource:name:data:

- (instancetype) initWithSubType: (int)  subType
synchronizationSource: (long long)  synchronizationSource
name: (NSString *)  name
data: (FMLiveSwitchDataBuffer *)  data 

Initializes a new instance of the FMLiveSwitchAppControlFrame class.

Parameters
subTypeType of the sub.
synchronizationSourceThe SSRC.
nameThe name.
dataThe data.

◆ name

- (NSString*) name

Gets the name.

◆ registeredPayloadType

+ (int) registeredPayloadType

Gets the application-specific payload type.

◆ setName:

- (void) setName: (NSString *)  value

Sets the name.

◆ setSubType:

- (void) setSubType: (int)  value

Sets the subtype to allow a set of APP packets to be defined under one unique name, or for any application-dependent data.

◆ setSynchronizationSource:

- (void) setSynchronizationSource: (long long)  value

Sets the synchronization source.

◆ subType

- (int) subType

Gets the subtype to allow a set of APP packets to be defined under one unique name, or for any application-dependent data.

◆ synchronizationSource

- (long long) synchronizationSource

Gets the synchronization source.