Class Codec

This structure reprensents one codec that can be offered or received

record

Hierarchy

Codec

Constructors

constructor

new Codec(id: number, encoding_name: string, media_type: Farstream.MediaType, clock_rate: number): Farstream.Codec

- Defined in @types/Gjs/Farstream-0.1.d.ts:1716
Allocates and initializes a #FsCodec structure

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

Properties

channels

channels: number

clock_rate

clock_rate: number

encoding_name

encoding_name: string

feedback_params

feedback_params: Farstream.FeedbackParameter[]

id

id: number

media_type

media_type: Farstream.MediaType

minimum_reporting_interval

minimum_reporting_interval: number

optional_params

optional_params: Farstream.CodecParameter[]

Static name

name: string

Methods

add_feedback_parameter

add_feedback_parameter(type: string, subtype: string, extra_params: string): void

- Defined in @types/Gjs/Farstream-0.1.d.ts:1642
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
- extra_params: string
  
  The extra_params of the feeback parameter
Returns void

add_optional_parameter

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

- Defined in @types/Gjs/Farstream-0.1.d.ts:1648
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

are_equal

are_equal(codec2: Farstream.Codec): boolean

- Defined in @types/Gjs/Farstream-0.1.d.ts:1655
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 @types/Gjs/Farstream-0.1.d.ts:1659
Copies a #FsCodec structure.

Returns Farstream.Codec

destroy

destroy(): void

- Defined in @types/Gjs/Farstream-0.1.d.ts:1660
Returns void

get_feedback_parameter

get_feedback_parameter(type: string, subtype: string, extra_params: string): Farstream.FeedbackParameter

- Defined in @types/Gjs/Farstream-0.1.d.ts:1668
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
- extra_params: string
  
  The extra_params of the parameter to search for or %NULL for any extra_params
Returns Farstream.FeedbackParameter

get_optional_parameter

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

- Defined in @types/Gjs/Farstream-0.1.d.ts:1675
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

remove_feedback_parameter

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

- Defined in @types/Gjs/Farstream-0.1.d.ts:1682
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

remove_optional_parameter

remove_optional_parameter(param: Farstream.CodecParameter): void

- Defined in @types/Gjs/Farstream-0.1.d.ts:1689
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

to_string

to_string(): string

- Defined in @types/Gjs/Farstream-0.1.d.ts:1693
Returns a newly-allocated string representing the codec

Returns string

Static new

new(id: number, encoding_name: string, media_type: Farstream.MediaType, clock_rate: number): Farstream.Codec

- Defined in @types/Gjs/Farstream-0.1.d.ts:1725
Allocates and initializes a #FsCodec structure

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