Class Codec

This structure reprensents one codec that can be offered or received

record

Hierarchy

Codec

Constructors

constructor

new Codec(id: number, encodingName: string, mediaType: Farstream.MediaType, clockRate: number): Farstream.Codec

- Defined in Farstream-0.2.d.ts:1949
Allocates and initializes a #FsCodec structure

Parameters
- id: number
  
  codec identifier, if RTP this should be based on IETF RTP payload types
- encodingName: string
  
  Name of media type this encodes
- mediaType: Farstream.MediaType
  
  #FsMediaType for type of codec
- clockRate: number
  
  The clock rate this codec encodes at, if applicable
Returns Farstream.Codec

Properties

channels

channels: number

Number of channels codec should decode

field

clockRate

clockRate: number

clock rate of this stream

field

encodingName

encodingName: string

the name of the codec

field

feedbackParams

feedbackParams: Farstream.FeedbackParameter[]

key triplets of feedbck param type, subtype and extra string that is supported for this codec

field

id

id: number

numeric identifier for encoding, eg. PT for SDP

field

mediaType

mediaType: Farstream.MediaType

type of media this codec is for

field

minimumReportingInterval

minimumReportingInterval: number

The minimum interval between two RTCP reports, If it is not specified (G_MAXUINT), it is up to the protocol to decide (it is 5 seconds for RTP).

field

optionalParams

optionalParams: Farstream.CodecParameter[]

key pairs of param name to param data

field

Static name

name: string

Methods

addFeedbackParameter

addFeedbackParameter(type: string, subtype: string, extraParams: string): void

- Defined in Farstream-0.2.d.ts:1876
This function adds an new feedback parameter to a #FsCodec

Parameters
- type: string
  
  The type of the feedback parameter
- subtype: string
  
  The subtype of the feedback parameter
- extraParams: string
  
  The extra_params of the feeback parameter
Returns void

addOptionalParameter

addOptionalParameter(name: string, value: string): void

- Defined in Farstream-0.2.d.ts:1882
This function adds an new optional parameter to a #FsCodec

Parameters
- name: string
  
  The name of the optional parameter
- value: string
  
  The extra_params of the optional parameter
Returns void

areEqual

areEqual(codec2: Farstream.Codec): boolean

- Defined in Farstream-0.2.d.ts:1889
Compare two codecs, it will declare two codecs to be identical even if their optional parameters are in a different order. %NULL encoding names are ignored.

Parameters
- codec2: Farstream.Codec
  
  Second codec
Returns boolean

copy

copy(): Farstream.Codec

- Defined in Farstream-0.2.d.ts:1893
Copies a #FsCodec structure.

Returns Farstream.Codec

getFeedbackParameter

getFeedbackParameter(type: string, subtype: string, extraParams: string): Farstream.FeedbackParameter

- Defined in Farstream-0.2.d.ts:1901
Finds the #FsFeedbackParameter in the #FsCodec that has the requested subtype, type and extra_params. One of which must be non-NULL;

Parameters
- type: string
  
  The subtype of the parameter to search for or %NULL for any type
- subtype: string
  
  The subtype of the parameter to search for or %NULL for any subtype
- extraParams: string
  
  The extra_params of the parameter to search for or %NULL for any extra_params
Returns Farstream.FeedbackParameter

getOptionalParameter

getOptionalParameter(name: string, value: string): Farstream.CodecParameter

- Defined in Farstream-0.2.d.ts:1908
Finds the #FsCodecParameter in the #FsCodec that has the requested name and, if not %NULL, the requested value

Parameters
- name: string
  
  The name of the parameter to search for
- value: string
  
  The value of the parameter to search for or %NULL for any value
Returns Farstream.CodecParameter

removeFeedbackParameter

removeFeedbackParameter(item: Farstream.FeedbackParameter[]): void

- Defined in Farstream-0.2.d.ts:1915
Removes an optional parameter from a codec.

NULL param will do nothing.

Parameters
- item: Farstream.FeedbackParameter[]
  
  a pointer to the #GList element to remove that contains a #FsFeedbackParameter
Returns void

removeOptionalParameter

removeOptionalParameter(param: Farstream.CodecParameter): void

- Defined in Farstream-0.2.d.ts:1922
Removes an optional parameter from a codec.

NULL param will do nothing.

Parameters
- param: Farstream.CodecParameter
  
  a pointer to the #FsCodecParameter to remove
Returns void

toString

toString(): string

- Defined in Farstream-0.2.d.ts:1926
Returns a newly-allocated string representing the codec

Returns string

Static new

new(id: number, encodingName: string, mediaType: Farstream.MediaType, clockRate: number): Farstream.Codec

- Defined in Farstream-0.2.d.ts:1958
Allocates and initializes a #FsCodec structure

Parameters
- id: number
  
  codec identifier, if RTP this should be based on IETF RTP payload types
- encodingName: string
  
  Name of media type this encodes
- mediaType: Farstream.MediaType
  
  #FsMediaType for type of codec
- clockRate: number
  
  The clock rate this codec encodes at, if applicable
Returns Farstream.Codec

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

id: number

encodingName: string

mediaType: Farstream.MediaType

clockRate: number

Returns Farstream.Codec

Properties

channels

clockRate

encodingName

feedbackParams

id

mediaType

minimumReportingInterval

optionalParams

Static name

Methods

addFeedbackParameter

Parameters

type: string

subtype: string

extraParams: string

Returns void

addOptionalParameter

Parameters

name: string

value: string

Returns void

areEqual

Parameters

codec2: Farstream.Codec

Returns boolean

copy

Returns Farstream.Codec

getFeedbackParameter

Parameters

type: string

subtype: string

extraParams: string

Returns Farstream.FeedbackParameter

getOptionalParameter

Parameters

name: string

value: string

Returns Farstream.CodecParameter

removeFeedbackParameter

Parameters

item: Farstream.FeedbackParameter[]

Returns void

removeOptionalParameter

Parameters

param: Farstream.CodecParameter

Returns void

toString

Returns string

Static new

Parameters

id: number

encodingName: string

mediaType: Farstream.MediaType

clockRate: number

Returns Farstream.Codec