FMIceLinkByeControlFrame Class Reference

Inherits from FMIceLinkMediaControlFrame : NSObject
Declared in FMIceLinkByeControlFrame.h
FMIceLinkByeControlFrame.m

Overview

An RTCP BYE packet.

+ byeControlFrame

Initializes a new instance of the FMIceLinkByeControlFrame class.
+ (FMIceLinkByeControlFrame *)byeControlFrame

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

+ byeControlFrameWithBuffer:

Initializes a new instance of the FMIceLinkByeControlFrame class.
+ (FMIceLinkByeControlFrame *)byeControlFrameWithBuffer:(FMIceLinkDataBuffer *)buffer

Parameters

buffer

The packet.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

+ byeControlFrameWithSynchronizationSource:

Initializes a new instance of the FMIceLinkByeControlFrame class.
+ (FMIceLinkByeControlFrame *)byeControlFrameWithSynchronizationSource:(long long)synchronizationSource

Parameters

synchronizationSource

The synchronization source.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

+ byeControlFrameWithSynchronizationSource:reasonForLeaving:

Initializes a new instance of the FMIceLinkByeControlFrame class.
+ (FMIceLinkByeControlFrame *)byeControlFrameWithSynchronizationSource:(long long)synchronizationSource reasonForLeaving:(NSString *)reasonForLeaving

Parameters

synchronizationSource

The synchronization source.
reasonForLeaving

The reason for leaving.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

+ byeControlFrameWithSynchronizationSources:

Initializes a new instance of the FMIceLinkByeControlFrame class.
+ (FMIceLinkByeControlFrame *)byeControlFrameWithSynchronizationSources:(NSMutableArray *)synchronizationSources

Parameters

synchronizationSources

The synchronization sources.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

+ byeControlFrameWithSynchronizationSources:contributingSources:

Initializes a new instance of the FMIceLinkByeControlFrame class.
+ (FMIceLinkByeControlFrame *)byeControlFrameWithSynchronizationSources:(NSMutableArray *)synchronizationSources contributingSources:(NSMutableArray *)contributingSources

Parameters

synchronizationSources

The synchronization sources.
contributingSources

The contributing sources.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

+ byeControlFrameWithSynchronizationSources:contributingSources:reasonForLeaving:

Initializes a new instance of the FMIceLinkByeControlFrame class.
+ (FMIceLinkByeControlFrame *)byeControlFrameWithSynchronizationSources:(NSMutableArray *)synchronizationSources contributingSources:(NSMutableArray *)contributingSources reasonForLeaving:(NSString *)reasonForLeaving

Parameters

synchronizationSources

The synchronization sources.
contributingSources

The contributing sources.
reasonForLeaving

The reason for leaving.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

+ byeControlFrameWithSynchronizationSources:reasonForLeaving:

Initializes a new instance of the FMIceLinkByeControlFrame class.
+ (FMIceLinkByeControlFrame *)byeControlFrameWithSynchronizationSources:(NSMutableArray *)synchronizationSources reasonForLeaving:(NSString *)reasonForLeaving

Parameters

synchronizationSources

The synchronization sources.
reasonForLeaving

The reason for leaving.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

+ fixedPayloadHeaderLength

Gets the length of the fixed payload header.
+ (int)fixedPayloadHeaderLength

Discussion

Gets the length of the fixed payload header.

Declared In

FMIceLinkByeControlFrame.h

+ fixedReasonForLeavingPayloadHeaderLength

Gets the length of the fixed [reason](#//api/name/reason) for leaving header.
+ (int)fixedReasonForLeavingPayloadHeaderLength

Discussion

Gets the length of the fixed [reason](#//api/name/reason) for leaving header.

Declared In

FMIceLinkByeControlFrame.h

– init

Initializes a new instance of the FMIceLinkByeControlFrame class.
- (instancetype)init

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

– initWithBuffer:

Initializes a new instance of the FMIceLinkByeControlFrame class.
- (instancetype)initWithBuffer:(FMIceLinkDataBuffer *)buffer

Parameters

buffer

The packet.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

– initWithSynchronizationSource:

Initializes a new instance of the FMIceLinkByeControlFrame class.
- (instancetype)initWithSynchronizationSource:(long long)synchronizationSource

Parameters

synchronizationSource

The synchronization source.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

– initWithSynchronizationSource:reasonForLeaving:

Initializes a new instance of the FMIceLinkByeControlFrame class.
- (instancetype)initWithSynchronizationSource:(long long)synchronizationSource reasonForLeaving:(NSString *)reasonForLeaving

Parameters

synchronizationSource

The synchronization source.
reasonForLeaving

The reason for leaving.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

– initWithSynchronizationSources:

Initializes a new instance of the FMIceLinkByeControlFrame class.
- (instancetype)initWithSynchronizationSources:(NSMutableArray *)synchronizationSources

Parameters

synchronizationSources

The synchronization sources.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

– initWithSynchronizationSources:contributingSources:

Initializes a new instance of the FMIceLinkByeControlFrame class.
- (instancetype)initWithSynchronizationSources:(NSMutableArray *)synchronizationSources contributingSources:(NSMutableArray *)contributingSources

Parameters

synchronizationSources

The synchronization sources.
contributingSources

The contributing sources.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

– initWithSynchronizationSources:contributingSources:reasonForLeaving:

Initializes a new instance of the FMIceLinkByeControlFrame class.
- (instancetype)initWithSynchronizationSources:(NSMutableArray *)synchronizationSources contributingSources:(NSMutableArray *)contributingSources reasonForLeaving:(NSString *)reasonForLeaving

Parameters

synchronizationSources

The synchronization sources.
contributingSources

The contributing sources.
reasonForLeaving

The reason for leaving.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

– initWithSynchronizationSources:reasonForLeaving:

Initializes a new instance of the FMIceLinkByeControlFrame class.
- (instancetype)initWithSynchronizationSources:(NSMutableArray *)synchronizationSources reasonForLeaving:(NSString *)reasonForLeaving

Parameters

synchronizationSources

The synchronization sources.
reasonForLeaving

The reason for leaving.

Discussion

Initializes a new instance of the FMIceLinkByeControlFrame class.

Declared In

FMIceLinkByeControlFrame.h

– reason

Gets a value indicating whether this instance has a reason for leaving.
- (bool)reason

Discussion

Gets a value indicating whether this instance has a reason for leaving.

Declared In

FMIceLinkByeControlFrame.h

– reasonForLeaving

Gets the [reason](#//api/name/reason) for leaving as a string.
- (NSString *)reasonForLeaving

Discussion

Gets the [reason](#//api/name/reason) for leaving as a string.

Declared In

FMIceLinkByeControlFrame.h

– reasonForLeavingLength

Gets the length of the [reason](#//api/name/reason) for leaving.
- (int)reasonForLeavingLength

Discussion

Gets the length of the [reason](#//api/name/reason) for leaving.

Declared In

FMIceLinkByeControlFrame.h

– reasonForLeavingOffset

Gets the offset of the FMIceLinkByeControlFrame#[reasonForLeaving](#//api/name/reasonForLeaving) in the payload.
- (int)reasonForLeavingOffset

Discussion

Gets the offset of the FMIceLinkByeControlFrame#[reasonForLeaving](#//api/name/reasonForLeaving) in the payload.

Declared In

FMIceLinkByeControlFrame.h

– reasonForLeavingPayload

Gets the [reason](#//api/name/reason) for leaving.
- (FMIceLinkDataBuffer *)reasonForLeavingPayload

Discussion

Gets the [reason](#//api/name/reason) for leaving.

Declared In

FMIceLinkByeControlFrame.h

+ registeredPayloadType

Gets the goodbye payload type.
+ (int)registeredPayloadType

Discussion

Gets the goodbye payload type.

Declared In

FMIceLinkByeControlFrame.h

– setSources:

Sets the synchronization and contributing [sources](#//api/name/sources).
- (void)setSources:(NSMutableArray *)value

Discussion

Sets the synchronization and contributing [sources](#//api/name/sources).

Declared In

FMIceLinkByeControlFrame.h

– sourceCount

Gets the number of FMIceLinkByeControlFrame#[sources](#//api/name/sources).
- (int)sourceCount

Discussion

Gets the number of FMIceLinkByeControlFrame#[sources](#//api/name/sources).

Declared In

FMIceLinkByeControlFrame.h

– sources

Gets the synchronization and contributing sources.
- (NSMutableArray *)sources

Discussion

Gets the synchronization and contributing sources.

Declared In

FMIceLinkByeControlFrame.h

– sourcesLength

Gets the length of the FMIceLinkByeControlFrame#[sources](#//api/name/sources) in bytes.
- (int)sourcesLength

Discussion

Gets the length of the FMIceLinkByeControlFrame#[sources](#//api/name/sources) in bytes.

Declared In

FMIceLinkByeControlFrame.h

– sourcesPayloadOffset

Gets the offset of the FMIceLinkByeControlFrame#[sources](#//api/name/sources) array in the payload.
- (int)sourcesPayloadOffset

Discussion

Gets the offset of the FMIceLinkByeControlFrame#[sources](#//api/name/sources) array in the payload.

Declared In

FMIceLinkByeControlFrame.h