Gjsify LogoGjsify Logo

This structure reprensents one codec that can be offered or received

record

Hierarchy

  • Codec

Index

Constructors

  • 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: number

Number of channels codec should decode

field
clock_rate: number

clock rate of this stream

field
encoding_name: string

the name of the codec

field
feedback_params: Farstream.FeedbackParameter[]

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

field
id: number

numeric identifier for encoding, eg. PT for SDP

field
media_type: Farstream.MediaType

type of media this codec is for

field
minimum_reporting_interval: 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
optional_params: Farstream.CodecParameter[]

key pairs of param name to param data

field
name: string

Methods

  • add_feedback_parameter(type: string, subtype: string, extra_params: string): void
  • 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(name: string, value: string): void
  • 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

  • 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

    Returns boolean

  • 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

  • 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

  • to_string(): string
  • 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

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method