Namespace Farstream

Index

Enumerations

Interfaces

Variables

Functions

Variables

Const CODEC_FORMAT

CODEC_FORMAT: string

A format that can be used in printf like format strings to format a FsCodec

Const CODEC_ID_ANY

CODEC_ID_ANY: number

If the id of a #FsCodec is #FS_CODEC_ID_ANY, then it will be replaced with a dynamic payload type at runtime

Const CODEC_ID_DISABLE

CODEC_ID_DISABLE: number

If the id of a #FsCodec is #FS_CODEC_ID_DISABLE, then this codec will not be used

Const RTP_HEADER_EXTENSION_FORMAT

RTP_HEADER_EXTENSION_FORMAT: string

A format that can be used in printf like format strings to format a FsRtpHeaderExtension

Functions

candidate_list_copy

candidate_list_copy(candidate_list: Farstream.Codec[]): Farstream.Codec[]

- Defined in @types/Gjs/Farstream-0.2.d.ts:295
Copies a GList of #FsCandidate and its contents

Parameters
- candidate_list: Farstream.Codec[]
  
  A GList of #FsCandidate
Returns Farstream.Codec[]

codec_list_are_equal

codec_list_are_equal(list1: Farstream.Codec[], list2: Farstream.Codec[]): boolean

- Defined in @types/Gjs/Farstream-0.2.d.ts:301
Verifies if two glist of fscodecs are identical

Parameters
- list1: Farstream.Codec[]
  
  a #GList of #FsCodec
- list2: Farstream.Codec[]
  
  a #GList of #FsCodec
Returns boolean

codec_list_copy

codec_list_copy(codec_list: Farstream.Codec[]): Farstream.Codec[]

- Defined in @types/Gjs/Farstream-0.2.d.ts:306
Copies a list of #FsCodec structures.

Parameters
- codec_list: Farstream.Codec[]
  
  a GList of #FsCodec to copy
Returns Farstream.Codec[]

codec_list_from_keyfile

codec_list_from_keyfile(filename: string): Farstream.Codec[]

- Defined in @types/Gjs/Farstream-0.2.d.ts:332
Reads the content of a #GKeyFile of the following format into a #GList of #FsCodec structures.
Example: |[ [audio/codec1] clock-rate=8000

[audio/codec1:1] clock-rate=16000

[audio/codec2] one_param=QCIF another_param=WOW

[video/codec3] wierd_param=42 feedback:nack/pli=1 feedback:tfrc=
```
@param filename Name of the #GKeyFile to read the codecs parameters from
```
Parameters
- filename: string
Returns Farstream.Codec[]

error_quark

error_quark(): Quark

- Defined in @types/Gjs/Farstream-0.2.d.ts:333
Returns Quark

media_type_to_string

media_type_to_string(media_type: Farstream.MediaType): string

- Defined in @types/Gjs/Farstream-0.2.d.ts:338
Gives a user-printable string representing the media type

Parameters
- media_type: Farstream.MediaType
  
  A media type
Returns string

parse_error

parse_error(object: GObject.Object, message: Gst.Message): [boolean, Farstream.Error, string]

- Defined in @types/Gjs/Farstream-0.2.d.ts:345
Parses a "farstream-farstream" message and checks if it matches the object parameters.

Parameters
- object: GObject.Object
  
  a #GObject to match against the message
- message: Gst.Message
  
  a #GstMessage to parse
Returns [boolean, Farstream.Error, string]

rtp_header_extension_list_copy

rtp_header_extension_list_copy(extensions: RtpHeaderExtension[]): RtpHeaderExtension[]

- Defined in @types/Gjs/Farstream-0.2.d.ts:350
Does a deep copy of a #GList of #FsRtpHeaderExtension

Parameters
- extensions: RtpHeaderExtension[]
  
  a #GList of #FsRtpHeaderExtension
Returns RtpHeaderExtension[]

rtp_header_extension_list_from_keyfile

rtp_header_extension_list_from_keyfile(filename: string, media_type: Farstream.MediaType): RtpHeaderExtension[]

- Defined in @types/Gjs/Farstream-0.2.d.ts:382
Reads the content of a #GKeyFile of the following format into a #GList of #FsRtpHeaderExtension structures.
The groups have a format "rtp-hdrext:audio:XXX" or "rtp-hdrext:video:XXX" where XXX is a unique string (per media type).

The valid keys are: id: a int between in the 1-255 and 4096-4351 ranges uri: a URI describing the RTP Header Extension direction (optional): To only send or receive a RTP Header Extension, possible values are "send", "receive", "none" or "both". Defaults to "both"

Example: |[ [rtp-hdrext:audio:a] id=1 uri=urn:ietf:params:rtp-hdrext:toffset

[rtp-hdrext:audio:abc] id=3 uri=urn:ietf:params:rtp-hdrext:ntp-64 direction=receive
```
@param filename Name of the #GKeyFile to read the RTP Header Extensions from
@param media_type The media type for which to get header extensions
```
Parameters
- filename: string
- media_type: Farstream.MediaType
Returns RtpHeaderExtension[]

utils_get_default_codec_preferences

utils_get_default_codec_preferences(element: Gst.Element): Farstream.Codec[]

- Defined in @types/Gjs/Farstream-0.2.d.ts:389
These default codec preferences should work with the elements that are available in the main GStreamer element repositories. They should be suitable for standards based protocols like SIP or XMPP.

Parameters
- element: Gst.Element
  
  Element for which to fetch default codec preferences
Returns Farstream.Codec[]

utils_get_default_rtp_header_extension_preferences

utils_get_default_rtp_header_extension_preferences(element: Gst.Element, media_type: Farstream.MediaType): Farstream.Codec[]

- Defined in @types/Gjs/Farstream-0.2.d.ts:397
These default rtp header extension preferences should work with the elements that are available in the main GStreamer element repositories. They should be suitable for standards based protocols like SIP or XMPP.

Parameters
- element: Gst.Element
  
  Element for which to fetch default RTP Header Extension preferences
- media_type: Farstream.MediaType
  
  The #FsMediaType for which to get default RTP Header Extension preferences
Returns Farstream.Codec[]

utils_set_bitrate

utils_set_bitrate(element: Gst.Element, bitrate: number): void

- Defined in @types/Gjs/Farstream-0.2.d.ts:407
This allows setting the bitrate on all elements that have a "bitrate" property without having to know the type or of the unit used by that element.

This will be obsolete in 0.11 (when all elements use bit/sec for the "bitrate" property.

Parameters
- element: Gst.Element
  
  The #GstElement
- bitrate: number
  
  The bitrate in bits/sec
Returns void

value_set_candidate_list

value_set_candidate_list(value: any, candidates: Farstream.Candidate[]): void

- Defined in @types/Gjs/Farstream-0.2.d.ts:414
This is for the bindings benefit. Works around the limitations of GObject introspection.

Parameters
- value: any
  
  a #GValue of type #FS_TYPE_CANDIDATE_LIST
- candidates: Farstream.Candidate[]
  
  A #GList of #FsCandidate
Returns void

Index

Enumerations

Classes

Interfaces

Variables

Functions

Variables

Const CODEC_FORMAT

Const CODEC_ID_ANY

Const CODEC_ID_DISABLE

Const RTP_HEADER_EXTENSION_FORMAT

Functions

candidate_list_copy

Parameters

candidate_list: Farstream.Codec[]

Returns Farstream.Codec[]

codec_list_are_equal

Parameters

list1: Farstream.Codec[]

list2: Farstream.Codec[]

Returns boolean

codec_list_copy

Parameters

codec_list: Farstream.Codec[]

Returns Farstream.Codec[]

codec_list_from_keyfile

Parameters

filename: string

Returns Farstream.Codec[]

error_quark

Returns Quark

media_type_to_string

Parameters

media_type: Farstream.MediaType

Returns string

parse_error

Parameters

object: GObject.Object

message: Gst.Message

Returns [boolean, Farstream.Error, string]

rtp_header_extension_list_copy

Parameters

extensions: RtpHeaderExtension[]

Returns RtpHeaderExtension[]

rtp_header_extension_list_from_keyfile

Parameters

filename: string

media_type: Farstream.MediaType

Returns RtpHeaderExtension[]

utils_get_default_codec_preferences

Parameters

element: Gst.Element

Returns Farstream.Codec[]

utils_get_default_rtp_header_extension_preferences

Parameters

element: Gst.Element

media_type: Farstream.MediaType

Returns Farstream.Codec[]

utils_set_bitrate

Parameters

element: Gst.Element

bitrate: number

Returns void

value_set_candidate_list

Parameters

value: any

candidates: Farstream.Candidate[]

Returns void