Class SDPMedia

The contents of the SDP "m=" field with all related fields.

record

Hierarchy

SDPMedia

Constructors

constructor

new SDPMedia(): SDPMedia

Returns SDPMedia

Properties

attributes

attributes: object[]

array of #GstSDPAttribute with the additional media attributes

field

bandwidths

bandwidths: object[]

array of #GstSDPBandwidth with media bandwidth information

field

connections

connections: object[]

array of #GstSDPConnection with media connection information

field

fmts

fmts: object[]

an array of #gchar formats

field

information

information: string

the media title

field

key

key: SDPKey

the encryption key

field

media

media: string

the media type

field

numPorts

numPorts: number

the number of ports or -1 if only one port was specified

field

port

port: number

the transport port to which the media stream will be sent

field

proto

proto: string

the transport protocol

field

Static name

name: string

Methods

addAttribute

addAttribute(key: string, value: string): SDPResult

- Defined in GstSdp-1.0.d.ts:1339
Add the attribute with key and value to media.

Parameters
- key: string
  
  a key
- value: string
  
  a value
Returns SDPResult

addBandwidth

addBandwidth(bwtype: string, bandwidth: number): SDPResult

- Defined in GstSdp-1.0.d.ts:1345
Add the bandwidth information with bwtype and bandwidth to media.

Parameters
- bwtype: string
  
  the bandwidth modifier type
- bandwidth: number
  
  the bandwidth in kilobits per second
Returns SDPResult

addConnection

addConnection(nettype: string, addrtype: string, address: string, ttl: number, addrNumber: number): SDPResult

- Defined in GstSdp-1.0.d.ts:1354
Add the given connection parameters to media.

Parameters
- nettype: string
  
  the type of network. "IN" is defined to have the meaning "Internet".
- addrtype: string
  
  the type of address.
- address: string
  
  the address
- ttl: number
  
  the time to live of the address
- addrNumber: number
  
  the number of layers
Returns SDPResult

addFormat

addFormat(format: string): SDPResult

- Defined in GstSdp-1.0.d.ts:1359
Add the format information to media.

Parameters
- format: string
  
  the format
Returns SDPResult

asText

asText(): string

- Defined in GstSdp-1.0.d.ts:1363
Convert the contents of media to a text string.

Returns string

attributesLen

attributesLen(): number

- Defined in GstSdp-1.0.d.ts:1367
Get the number of attribute fields in media.

Returns number

attributesToCaps

attributesToCaps(caps: Gst.Caps): SDPResult

- Defined in GstSdp-1.0.d.ts:1372
Mapping of attributes of #GstSDPMedia to #GstCaps

Parameters
- caps: Gst.Caps
  
  a #GstCaps
Returns SDPResult

bandwidthsLen

bandwidthsLen(): number

- Defined in GstSdp-1.0.d.ts:1376
Get the number of bandwidth fields in media.

Returns number

connectionsLen

connectionsLen(): number

- Defined in GstSdp-1.0.d.ts:1380
Get the number of connection fields in media.

Returns number

copy

copy(): [SDPResult, SDPMedia]

- Defined in GstSdp-1.0.d.ts:1385
Allocate a new copy of media and store the result in copy. The value in copy should be release with gst_sdp_media_free function.

Returns [SDPResult, SDPMedia]

formatsLen

formatsLen(): number

- Defined in GstSdp-1.0.d.ts:1389
Get the number of formats in media.

Returns number

free

free(): SDPResult

- Defined in GstSdp-1.0.d.ts:1395
Free all resources allocated by media. media should not be used anymore after this function. This function should be used when media was dynamically allocated with gst_sdp_media_new().

Returns SDPResult

getAttribute

getAttribute(idx: number): SDPAttribute

- Defined in GstSdp-1.0.d.ts:1400
Get the attribute at position idx in media.

Parameters
- idx: number
  
  an index
Returns SDPAttribute

getAttributeVal

getAttributeVal(key: string): string

- Defined in GstSdp-1.0.d.ts:1405
Get the first attribute value for key in media.

Parameters
- key: string
  
  a key
Returns string

getAttributeValN

getAttributeValN(key: string, nth: number): string

- Defined in GstSdp-1.0.d.ts:1411
Get the nth attribute value for key in media.

Parameters
- key: string
  
  a key
- nth: number
  
  an index
Returns string

getBandwidth

getBandwidth(idx: number): SDPBandwidth

- Defined in GstSdp-1.0.d.ts:1416
Get the bandwidth at position idx in media.

Parameters
- idx: number
  
  an index
Returns SDPBandwidth

getCapsFromMedia

getCapsFromMedia(pt: number): Gst.Caps

- Defined in GstSdp-1.0.d.ts:1429
Mapping of caps from SDP fields:

a=rtpmap:(payload) (encoding_name)/(clock_rate)[/(encoding_params)]

a=framesize:(payload) (width)-(height)

a=fmtp:(payload) (param)[=(value)];...

Note that the extmap attribute is set only by gst_sdp_media_attributes_to_caps().

Parameters
- pt: number
  
  a payload type
Returns Gst.Caps

getConnection

getConnection(idx: number): SDPConnection

- Defined in GstSdp-1.0.d.ts:1434
Get the connection at position idx in media.

Parameters
- idx: number
  
  an index
Returns SDPConnection

getFormat

getFormat(idx: number): string

- Defined in GstSdp-1.0.d.ts:1439
Get the format information at position idx in media.

Parameters
- idx: number
  
  an index
Returns string

getInformation

getInformation(): string

- Defined in GstSdp-1.0.d.ts:1443
Get the information of media

Returns string

getKey

getKey(): SDPKey

- Defined in GstSdp-1.0.d.ts:1447
Get the encryption information from media.

Returns SDPKey

getMedia

getMedia(): string

- Defined in GstSdp-1.0.d.ts:1451
Get the media description of media.

Returns string

getNumPorts

getNumPorts(): number

- Defined in GstSdp-1.0.d.ts:1455
Get the number of ports for media.

Returns number

getPort

getPort(): number

- Defined in GstSdp-1.0.d.ts:1459
Get the port number for media.

Returns number

getProto

getProto(): string

- Defined in GstSdp-1.0.d.ts:1463
Get the transport protocol of media

Returns string

init

init(): SDPResult

- Defined in GstSdp-1.0.d.ts:1472
Initialize media so that its contents are as if it was freshly allocated with gst_sdp_media_new(). This function is mostly used to initialize a media allocated on the stack. gst_sdp_media_uninit() undoes this operation.

When this function is invoked on newly allocated data (with malloc or on the stack), its contents should be set to 0 before calling this function.

Returns SDPResult

insertAttribute

insertAttribute(idx: number, attr: SDPAttribute): SDPResult

- Defined in GstSdp-1.0.d.ts:1479
Insert the attribute to media at idx. When idx is -1, the attribute is appended.

Parameters
- idx: number
  
  an index
- attr: SDPAttribute
  
  a #GstSDPAttribute
Returns SDPResult

insertBandwidth

insertBandwidth(idx: number, bw: SDPBandwidth): SDPResult

- Defined in GstSdp-1.0.d.ts:1486
Insert the bandwidth information to media at idx. When idx is -1, the bandwidth is appended.

Parameters
- idx: number
  
  an index
- bw: SDPBandwidth
  
  a #GstSDPBandwidth
Returns SDPResult

insertConnection

insertConnection(idx: number, conn: SDPConnection): SDPResult

- Defined in GstSdp-1.0.d.ts:1493
Insert the connection information to media at idx. When idx is -1, the connection is appended.

Parameters
- idx: number
  
  an index
- conn: SDPConnection
  
  a #GstSDPConnection
Returns SDPResult

insertFormat

insertFormat(idx: number, format: string): SDPResult

- Defined in GstSdp-1.0.d.ts:1500
Insert the format information to media at idx. When idx is -1, the format is appended.

Parameters
- idx: number
  
  an index
- format: string
  
  the format
Returns SDPResult

parseKeymgmt

parseKeymgmt(): [SDPResult, MIKEYMessage]

- Defined in GstSdp-1.0.d.ts:1505
Creates a new #GstMIKEYMessage after parsing the key-mgmt attribute from a #GstSDPMedia.

Returns [SDPResult, MIKEYMessage]

removeAttribute

removeAttribute(idx: number): SDPResult

- Defined in GstSdp-1.0.d.ts:1510
Remove the attribute in media at idx.

Parameters
- idx: number
  
  an index
Returns SDPResult

removeBandwidth

removeBandwidth(idx: number): SDPResult

- Defined in GstSdp-1.0.d.ts:1515
Remove the bandwidth information in media at idx.

Parameters
- idx: number
  
  an index
Returns SDPResult

removeConnection

removeConnection(idx: number): SDPResult

- Defined in GstSdp-1.0.d.ts:1520
Remove the connection information in media at idx.

Parameters
- idx: number
  
  an index
Returns SDPResult

removeFormat

removeFormat(idx: number): SDPResult

- Defined in GstSdp-1.0.d.ts:1525
Remove the format information in media at idx.

Parameters
- idx: number
  
  an index
Returns SDPResult

replaceAttribute

replaceAttribute(idx: number, attr: SDPAttribute): SDPResult

- Defined in GstSdp-1.0.d.ts:1531
Replace the attribute in media at idx with attr.

Parameters
- idx: number
  
  an index
- attr: SDPAttribute
  
  a #GstSDPAttribute
Returns SDPResult

replaceBandwidth

replaceBandwidth(idx: number, bw: SDPBandwidth): SDPResult

- Defined in GstSdp-1.0.d.ts:1537
Replace the bandwidth information in media at idx with bw.

Parameters
- idx: number
  
  an index
- bw: SDPBandwidth
  
  a #GstSDPBandwidth
Returns SDPResult

replaceConnection

replaceConnection(idx: number, conn: SDPConnection): SDPResult

- Defined in GstSdp-1.0.d.ts:1543
Replace the connection information in media at idx with conn.

Parameters
- idx: number
  
  an index
- conn: SDPConnection
  
  a #GstSDPConnection
Returns SDPResult

replaceFormat

replaceFormat(idx: number, format: string): SDPResult

- Defined in GstSdp-1.0.d.ts:1549
Replace the format information in media at idx with format.

Parameters
- idx: number
  
  an index
- format: string
  
  the format
Returns SDPResult

setInformation

setInformation(information: string): SDPResult

- Defined in GstSdp-1.0.d.ts:1554
Set the media information of media to information.

Parameters
- information: string
  
  the media information
Returns SDPResult

setKey

setKey(type: string, data: string): SDPResult

- Defined in GstSdp-1.0.d.ts:1560
Adds the encryption information to media.

Parameters
- type: string
  
  the encryption type
- data: string
  
  the encryption data
Returns SDPResult

setMedia

setMedia(med: string): SDPResult

- Defined in GstSdp-1.0.d.ts:1565
Set the media description of media to med.

Parameters
- med: string
  
  the media description
Returns SDPResult

setPortInfo

setPortInfo(port: number, numPorts: number): SDPResult

- Defined in GstSdp-1.0.d.ts:1571
Set the port information in media.

Parameters
- port: number
  
  the port number
- numPorts: number
  
  the number of ports
Returns SDPResult

setProto

setProto(proto: string): SDPResult

- Defined in GstSdp-1.0.d.ts:1576
Set the media transport protocol of media to proto.

Parameters
- proto: string
  
  the media transport protocol
Returns SDPResult

uninit

uninit(): SDPResult

- Defined in GstSdp-1.0.d.ts:1582
Free all resources allocated in media. media should not be used anymore after this function. This function should be used when media was allocated on the stack and initialized with gst_sdp_media_init().

Returns SDPResult

Static new

new(): [SDPResult, SDPMedia]

- Defined in GstSdp-1.0.d.ts:1600
Allocate a new GstSDPMedia and store the result in media.

Returns [SDPResult, SDPMedia]

Static setMediaFromCaps

setMediaFromCaps(caps: Gst.Caps, media: SDPMedia): SDPResult

- Defined in GstSdp-1.0.d.ts:1616
Mapping of caps to SDP fields:

a=rtpmap:(payload) (encoding_name) or (clock_rate)[or (encoding_params)]

a=framesize:(payload) (width)-(height)

a=fmtp:(payload) (param)[=(value)];...

a=rtcp-fb:(payload) (param1) [param2]...

a=extmap:(id)[/direction] (extensionname) (extensionattributes)

Parameters
- caps: Gst.Caps
  
  a #GstCaps
- media: SDPMedia
  
  a #GstSDPMedia
Returns SDPResult

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns SDPMedia

Properties

attributes

bandwidths

connections

fmts

information

key

media

numPorts

port

proto

Static name

Methods

addAttribute

Parameters

key: string

value: string

Returns SDPResult

addBandwidth

Parameters

bwtype: string

bandwidth: number

Returns SDPResult

addConnection

Parameters

nettype: string

addrtype: string

address: string

ttl: number

addrNumber: number

Returns SDPResult

addFormat

Parameters

format: string

Returns SDPResult

asText

Returns string

attributesLen

Returns number

attributesToCaps

Parameters

caps: Gst.Caps

Returns SDPResult

bandwidthsLen

Returns number

connectionsLen

Returns number

copy

Returns [SDPResult, SDPMedia]

formatsLen

Returns number

free

Returns SDPResult

getAttribute

Parameters

idx: number

Returns SDPAttribute

getAttributeVal

Parameters

key: string

Returns string

getAttributeValN

Parameters

key: string

nth: number

Returns string

getBandwidth

Parameters

idx: number

Returns SDPBandwidth

getCapsFromMedia

Parameters