GstSdp-1.0 ▶ GstSdp ▶ SDPMedia

constructor

• new SDPMedia(
      properties?: Partial<
          {
              attributes: any[];
              bandwidths: any[];
              connections: any[];
              fmts: any[];
              information: string;
              key: SDPKey;
              media: string;
              num_ports: number;
              port: number;
              proto: string;
          },
      >,
  ): SDPMedia

  Parameters

  • Optionalproperties: Partial<
        {
            attributes: any[];
            bandwidths: any[];
            connections: any[];
            fmts: any[];
            information: string;
            key: SDPKey;
            media: string;
            num_ports: number;
            port: number;
            proto: string;
        },
    >

  Returns SDPMedia

attributes

bandwidths

connections

fmts

information

key

media

num_ports

port

proto

Static$gtype

add_attribute

• add_attribute(key: string, value?: string): SDPResult

  Add the attribute with key and value to media.

  Parameters

  • key: string

    a key

  • Optionalvalue: string

    a value

  Returns SDPResult

  #GST_SDP_OK.

add_bandwidth

• add_bandwidth(bwtype: string, bandwidth: number): SDPResult

  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

  #GST_SDP_OK.

add_connection

• add_connection(
      nettype: string,
      addrtype: string,
      address: string,
      ttl: number,
      addr_number: number,
  ): SDPResult

  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

  • addr_number: number

    the number of layers

  Returns SDPResult

  a GstSdp.SDPResult.

add_format

• add_format(format: string): SDPResult

  Add the format information to media.

  Parameters

  • format: string

    the format

  Returns SDPResult

  #GST_SDP_OK.

as_text

• as_text(): string

  Convert the contents of media to a text string.

  Returns string

  A dynamically allocated string representing the media.

attributes_len

• attributes_len(): number

  Get the number of attribute fields in media.

  Returns number

  the number of attributes in media.

attributes_to_caps

• attributes_to_caps(caps: Gst.Caps): SDPResult

  Mapping of attributes of GstSdp.SDPMedia to Gst.Caps

  Parameters

  • caps: Gst.Caps

    a Gst.Caps

  Returns SDPResult

  a GstSdp.SDPResult.

bandwidths_len

• bandwidths_len(): number

  Get the number of bandwidth fields in media.

  Returns number

  the number of bandwidths in media.

connections_len

• connections_len(): number

  Get the number of connection fields in media.

  Returns number

  the number of connections in media.

copy

• copy(): [SDPResult, SDPMedia]

  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]

  a GstSdp.SDPResult

formats_len

• formats_len(): number

  Get the number of formats in media.

  Returns number

  the number of formats in media.

free

• free(): SDPResult

  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

  a GstSdp.SDPResult.

get_attribute

• get_attribute(idx: number): SDPAttribute

  Get the attribute at position idx in media.

  Parameters

  • idx: number

    an index

  Returns SDPAttribute

  the GstSdp.SDPAttribute at position idx.

get_attribute_val

• get_attribute_val(key: string): string

  Get the first attribute value for key in media.

  Parameters

  • key: string

    a key

  Returns string

  the first attribute value for key.

get_attribute_val_n

• get_attribute_val_n(key: string, nth: number): string

  Get the nth attribute value for key in media.

  Parameters

  • key: string

    a key

  • nth: number

    an index

  Returns string

  the nth attribute value.

get_bandwidth

• get_bandwidth(idx: number): SDPBandwidth

  Get the bandwidth at position idx in media.

  Parameters

  • idx: number

    an index

  Returns SDPBandwidth

  the GstSdp.SDPBandwidth at position idx.

get_caps_from_media

• get_caps_from_media(pt: number): Gst.Caps

  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, ssrc and rid attributes are set only by gst_sdp_media_attributes_to_caps().

  Parameters

  • pt: number

    a payload type

  Returns Gst.Caps

  a Gst.Caps, or null if an error happened

get_connection

• get_connection(idx: number): SDPConnection

  Get the connection at position idx in media.

  Parameters

  • idx: number

    an index

  Returns SDPConnection

  the GstSdp.SDPConnection at position idx.

get_format

• get_format(idx: number): string

  Get the format information at position idx in media.

  Parameters

  • idx: number

    an index

  Returns string

  the format at position idx.

get_information

• get_information(): string

  Get the information of media

  Returns string

  the information of media.

get_key

• get_key(): SDPKey

  Get the encryption information from media.

  Returns SDPKey

  a GstSdp.SDPKey.

get_media

• get_media(): string

  Get the media description of media.

  Returns string

  the media description.

get_num_ports

• get_num_ports(): number

  Get the number of ports for media.

  Returns number

  the number of ports for media.

get_port

• get_port(): number

  Get the port number for media.

  Returns number

  the port number of media.

get_proto

• get_proto(): string

  Get the transport protocol of media

  Returns string

  the transport protocol of media.

insert_attribute

• insert_attribute(idx: number, attr: SDPAttribute): SDPResult

  Insert the attribute to media at idx. When idx is -1, the attribute is appended.

  Parameters

  • idx: number

    an index

  • attr: SDPAttribute

    a GstSdp.SDPAttribute

  Returns SDPResult

  #GST_SDP_OK.

insert_bandwidth

• insert_bandwidth(idx: number, bw: SDPBandwidth): SDPResult

  Insert the bandwidth information to media at idx. When idx is -1, the bandwidth is appended.

  Parameters

  • idx: number

    an index

  • bw: SDPBandwidth

    a GstSdp.SDPBandwidth

  Returns SDPResult

  #GST_SDP_OK.

insert_connection

• insert_connection(idx: number, conn: SDPConnection): SDPResult

  Insert the connection information to media at idx. When idx is -1, the connection is appended.

  Parameters

  • idx: number

    an index

  • conn: SDPConnection

    a GstSdp.SDPConnection

  Returns SDPResult

  #GST_SDP_OK.

insert_format

• insert_format(idx: number, format: string): SDPResult

  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

  #GST_SDP_OK.

parse_keymgmt

• parse_keymgmt(): [SDPResult, MIKEYMessage]

  Creates a new GstSdp.MIKEYMessage after parsing the key-mgmt attribute from a GstSdp.SDPMedia.

  Returns [SDPResult, MIKEYMessage]

  a GstSdp.SDPResult.

remove_attribute

• remove_attribute(idx: number): SDPResult

  Remove the attribute in media at idx.

  Parameters

  • idx: number

    an index

  Returns SDPResult

  #GST_SDP_OK.

remove_bandwidth

• remove_bandwidth(idx: number): SDPResult

  Remove the bandwidth information in media at idx.

  Parameters

  • idx: number

    an index

  Returns SDPResult

  #GST_SDP_OK.

remove_connection

• remove_connection(idx: number): SDPResult

  Remove the connection information in media at idx.

  Parameters

  • idx: number

    an index

  Returns SDPResult

  #GST_SDP_OK.

remove_format

• remove_format(idx: number): SDPResult

  Remove the format information in media at idx.

  Parameters

  • idx: number

    an index

  Returns SDPResult

  #GST_SDP_OK.

replace_attribute

• replace_attribute(idx: number, attr: SDPAttribute): SDPResult

  Replace the attribute in media at idx with attr.

  Parameters

  • idx: number

    an index

  • attr: SDPAttribute

    a GstSdp.SDPAttribute

  Returns SDPResult

  #GST_SDP_OK.

replace_bandwidth

• replace_bandwidth(idx: number, bw: SDPBandwidth): SDPResult

  Replace the bandwidth information in media at idx with bw.

  Parameters

  • idx: number

    an index

  • bw: SDPBandwidth

    a GstSdp.SDPBandwidth

  Returns SDPResult

  #GST_SDP_OK.

replace_connection

• replace_connection(idx: number, conn: SDPConnection): SDPResult

  Replace the connection information in media at idx with conn.

  Parameters

  • idx: number

    an index

  • conn: SDPConnection

    a GstSdp.SDPConnection

  Returns SDPResult

  #GST_SDP_OK.

replace_format

• replace_format(idx: number, format: string): SDPResult

  Replace the format information in media at idx with format.

  Parameters

  • idx: number

    an index

  • format: string

    the format

  Returns SDPResult

  #GST_SDP_OK.

set_information

• set_information(information: string): SDPResult

  Set the media information of media to information.

  Parameters

  • information: string

    the media information

  Returns SDPResult

  #GST_SDP_OK.

set_key

• set_key(type: string, data: string): SDPResult

  Adds the encryption information to media.

  Parameters

  • type: string

    the encryption type

  • data: string

    the encryption data

  Returns SDPResult

  a GstSdp.SDPResult.

set_media

• set_media(med: string): SDPResult

  Set the media description of media to med.

  Parameters

  • med: string

    the media description

  Returns SDPResult

  #GST_SDP_OK.

set_port_info

• set_port_info(port: number, num_ports: number): SDPResult

  Set the port information in media.

  Parameters

  • port: number

    the port number

  • num_ports: number

    the number of ports

  Returns SDPResult

  #GST_SDP_OK.

set_proto

• set_proto(proto: string): SDPResult

  Set the media transport protocol of media to proto.

  Parameters

  • proto: string

    the media transport protocol

  Returns SDPResult

  #GST_SDP_OK.

uninit

• uninit(): SDPResult

  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

  a GstSdp.SDPResult.

Staticinit

• init(): [SDPResult, SDPMedia]

  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, SDPMedia]

Staticnew

• new(): [SDPResult, SDPMedia]

  Allocate a new GstSDPMedia and store the result in media.

  Returns [SDPResult, SDPMedia]

Staticset_media_from_caps

• set_media_from_caps(caps: Gst.Caps): [SDPResult, SDPMedia]

  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 Gst.Caps

  Returns [SDPResult, SDPMedia]