StreamInformation Class Reference

Instance Methods
(instancetype)	- init
(NSNumber *)	- getIndex
(void)	- setIndex:
(NSString *)	- getType
(void)	- setType:
(NSString *)	- getCodec
(void)	- setCodec:
(NSString *)	- getFullCodec
(void)	- setFullCodec:
(NSString *)	- getFormat
(void)	- setFormat:
(NSString *)	- getFullFormat
(void)	- setFullFormat:
(NSNumber *)	- getWidth
(void)	- setWidth:
(NSNumber *)	- getHeight
(void)	- setHeight:
(NSNumber *)	- getBitrate
(void)	- setBitrate:
(NSNumber *)	- getSampleRate
(void)	- setSampleRate:
(NSString *)	- getSampleFormat
(void)	- setSampleFormat:
(NSString *)	- getChannelLayout
(void)	- setChannelLayout:
(NSString *)	- getSampleAspectRatio
(void)	- setSampleAspectRatio:
(NSString *)	- getDisplayAspectRatio
(void)	- setDisplayAspectRatio:
(NSString *)	- getAverageFrameRate
(void)	- setAverageFrameRate:
(NSString *)	- getRealFrameRate
(void)	- setRealFrameRate:
(NSString *)	- getTimeBase
(void)	- setTimeBase:
(NSString *)	- getCodecTimeBase
(void)	- setCodecTimeBase:
(void)	- addMetadata::
(NSDictionary *)	- getMetadataEntries

Detailed Description

Stream information class.

Definition at line 25 of file StreamInformation.h.

Method Documentation

addMetadata::()

- (void) addMetadata:		(NSString*)	key
:		(NSString*)	value

Adds metadata.

Parameters

metadata

key and value

Definition at line 251 of file StreamInformation.m.

getAverageFrameRate()

- (NSString *) getAverageFrameRate

Returns average frame rate.

Returns

average frame rate in fps

Definition at line 219 of file StreamInformation.m.

getBitrate()

- (NSNumber *) getBitrate

Returns bitrate.

Returns

bitrate in kb/s

Definition at line 171 of file StreamInformation.m.

getChannelLayout()

- (NSString *) getChannelLayout

Returns channel layout.

Returns

channel layout

Definition at line 195 of file StreamInformation.m.

getCodec()

- (NSString *) getCodec

Returns stream codec.

Returns

stream codec

Definition at line 123 of file StreamInformation.m.

getCodecTimeBase()

- (NSString *) getCodecTimeBase

Returns codec time base.

Returns

codec time base in tbc

Definition at line 243 of file StreamInformation.m.

getDisplayAspectRatio()

- (NSString *) getDisplayAspectRatio

Returns display aspect ratio.

Returns

display aspect ratio

Definition at line 211 of file StreamInformation.m.

getFormat()

- (NSString *) getFormat

Returns stream format.

Returns

stream format

Definition at line 139 of file StreamInformation.m.

getFullCodec()

- (NSString *) getFullCodec

Returns full stream codec.

Returns

stream codec with additional profile and mode information

Definition at line 131 of file StreamInformation.m.

getFullFormat()

- (NSString *) getFullFormat

Returns full stream format.

Returns

stream format with

Definition at line 147 of file StreamInformation.m.

getHeight()

- (NSNumber *) getHeight

Returns height.

Returns

height in pixels

Definition at line 163 of file StreamInformation.m.

getIndex()

- (NSNumber *) getIndex

Returns stream index.

Returns

stream index, starting from zero

Definition at line 107 of file StreamInformation.m.

getMetadataEntries()

- (NSDictionary *) getMetadataEntries

Returns all metadata entries.

Returns

metadata dictionary

Definition at line 255 of file StreamInformation.m.

getRealFrameRate()

- (NSString *) getRealFrameRate

Returns real frame rate.

Returns

real frame rate in tbr

Definition at line 227 of file StreamInformation.m.

getSampleAspectRatio()

- (NSString *) getSampleAspectRatio

Returns sample aspect ratio.

Returns

sample aspect ratio

Definition at line 203 of file StreamInformation.m.

getSampleFormat()

- (NSString *) getSampleFormat

Returns sample format.

Returns

sample format

Definition at line 187 of file StreamInformation.m.

getSampleRate()

- (NSNumber *) getSampleRate

Returns sample rate.

Returns

sample rate in hz

Definition at line 179 of file StreamInformation.m.

getTimeBase()

- (NSString *) getTimeBase

Returns time base.

Returns

time base in tbn

Definition at line 235 of file StreamInformation.m.

getType()

- (NSString *) getType

Returns stream type.

Returns

stream type; audio or video

Definition at line 115 of file StreamInformation.m.

getWidth()

- (NSNumber *) getWidth

Returns width.

Returns

width in pixels

Definition at line 155 of file StreamInformation.m.

init()

- (instancetype) init

Definition at line 80 of file StreamInformation.m.

setAverageFrameRate:()

- (void) setAverageFrameRate:

(NSString*)

averageFrameRate

Sets average frame rate.

Parameters

average

frame rate in fps

Definition at line 223 of file StreamInformation.m.

setBitrate:()

- (void) setBitrate:

(NSNumber*)

bitrate

Sets bitrate.

Parameters

bitrate

in kb/s

Definition at line 175 of file StreamInformation.m.

setChannelLayout:()

- (void) setChannelLayout:

(NSString*)

channelLayout

Sets channel layout.

Parameters

channel

layout

Definition at line 199 of file StreamInformation.m.

setCodec:()

- (void) setCodec:

(NSString*)

codec

Sets stream codec.

Parameters

stream

codec

Definition at line 127 of file StreamInformation.m.

setCodecTimeBase:()

- (void) setCodecTimeBase:

(NSString*)

codecTimeBase

Sets codec time base.

Parameters

codec

time base in tbc

Definition at line 247 of file StreamInformation.m.

setDisplayAspectRatio:()

- (void) setDisplayAspectRatio:

(NSString*)

displayAspectRatio

Sets display aspect ratio.

Parameters

display

aspect ratio

Definition at line 215 of file StreamInformation.m.

setFormat:()

- (void) setFormat:

(NSString*)

format

Sets stream format.

Parameters

stream

format

Definition at line 143 of file StreamInformation.m.

setFullCodec:()

- (void) setFullCodec:

(NSString*)

fullCodec

Sets full stream codec.

Parameters

stream

codec with additional profile and mode information

Definition at line 135 of file StreamInformation.m.

setFullFormat:()

- (void) setFullFormat:

(NSString*)

fullFormat

Sets full stream format.

Parameters

stream

format with

Definition at line 151 of file StreamInformation.m.

setHeight:()

- (void) setHeight:

(NSNumber*)

height

Sets height.

Parameters

height

in pixels

Definition at line 167 of file StreamInformation.m.

setIndex:()

- (void) setIndex:

(NSNumber*)

index

Sets stream index.

Parameters

stream

index, starting from zero

Definition at line 111 of file StreamInformation.m.

setRealFrameRate:()

- (void) setRealFrameRate:

(NSString*)

realFrameRate

Sets real frame rate.

Parameters

real	frame rate in tbr

Definition at line 231 of file StreamInformation.m.

setSampleAspectRatio:()

- (void) setSampleAspectRatio:

(NSString*)

sampleAspectRatio

Sets sample aspect ratio.

Parameters

sample

aspect ratio

Definition at line 207 of file StreamInformation.m.

setSampleFormat:()

- (void) setSampleFormat:

(NSString*)

sampleFormat

Sets sample format.

Parameters

sample

format

Definition at line 191 of file StreamInformation.m.

setSampleRate:()

- (void) setSampleRate:

(NSNumber*)

sampleRate

Sets sample rate.

Parameters

sample

rate in hz

Definition at line 183 of file StreamInformation.m.

setTimeBase:()

- (void) setTimeBase:

(NSString*)

timeBase

Sets time base.

Parameters

time	base in tbn

Definition at line 239 of file StreamInformation.m.

setType:()

- (void) setType:

(NSString*)

type

Sets stream type.

Parameters

stream

type; audio or video

Definition at line 119 of file StreamInformation.m.

setWidth:()

- (void) setWidth:

(NSNumber*)

width

Sets width.

Parameters

width

in pixels

Definition at line 159 of file StreamInformation.m.

---

The documentation for this class was generated from the following files:

• StreamInformation.h
• StreamInformation.m