GstSdp-1.0 ▶ GstSdp ▶ SDPMessage

constructor

• new SDPMessage(
      properties?: Partial<
          {
              attributes: null[];
              bandwidths: null[];
              connection: SDPConnection;
              emails: null[];
              information: string;
              key: SDPKey;
              medias: null[];
              origin: SDPOrigin;
              phones: null[];
              session_name: string;
              times: null[];
              uri: string;
              version: string;
              zones: null[];
          },
      >,
  ): SDPMessage

  Parameters

  • Optionalproperties: Partial<
        {
            attributes: null[];
            bandwidths: null[];
            connection: SDPConnection;
            emails: null[];
            information: string;
            key: SDPKey;
            medias: null[];
            origin: SDPOrigin;
            phones: null[];
            session_name: string;
            times: null[];
            uri: string;
            version: string;
            zones: null[];
        },
    >

  Returns SDPMessage

attributes

bandwidths

connection

emails

information

key

medias

origin

phones

session_name

times

uri

version

zones

Static$gtype

add_attribute

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

  Add the attribute with key and value to msg.

  Parameters

  • key: string

    the key

  • value: string

    the value

  Returns SDPResult

  GST_SDP_OK.

add_bandwidth

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

  Add the specified bandwidth information to msg.

  Parameters

  • bwtype: string

    the bandwidth modifier type

  • bandwidth: number

    the bandwidth in kilobits per second

  Returns SDPResult

  a GstSdp.SDPResult.

add_email

• add_email(email: string): SDPResult

  Add email to the list of emails in msg.

  Parameters

  • email: string

    an email

  Returns SDPResult

  a GstSdp.SDPResult.

add_media

• add_media(media: SDPMedia): SDPResult

  Adds media to the array of medias in msg. This function takes ownership of the contents of media so that media will have to be reinitialized with gst_sdp_media_init() before it can be used again.

  Parameters

  • media: SDPMedia

    a GstSdp.SDPMedia to add

  Returns SDPResult

  a GstSdp.SDPResult.

add_phone

• add_phone(phone: string): SDPResult

  Add phone to the list of phones in msg.

  Parameters

  • phone: string

    a phone

  Returns SDPResult

  a GstSdp.SDPResult.

add_time

• add_time(start: string, stop: string, repeat: string[]): SDPResult

  Add time information start and stop to msg.

  Parameters

  • start: string

    the start time

  • stop: string

    the stop time

  • repeat: string[]

    the repeat times

  Returns SDPResult

  a GstSdp.SDPResult.

add_zone

• add_zone(adj_time: string, typed_time: string): SDPResult

  Add time zone information to msg.

  Parameters

  • adj_time: string

    the NTP time that a time zone adjustment happens

  • typed_time: string

    the offset from the time when the session was first scheduled

  Returns SDPResult

  a GstSdp.SDPResult.

as_text

• as_text(): string

  Convert the contents of msg to a text string.

  Returns string

  A dynamically allocated string representing the SDP description.

attributes_len

• attributes_len(): number

  Get the number of attributes in msg.

  Returns number

  the number of attributes in msg.

attributes_to_caps

• attributes_to_caps(caps: Gst.Caps): SDPResult

  Mapping of attributes of GstSdp.SDPMessage 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 information in msg.

  Returns number

  the number of bandwidth information in msg.

copy

• copy(): [SDPResult, SDPMessage]

  Allocate a new copy of msg and store the result in copy. The value in copy should be release with gst_sdp_message_free function.

  Returns [SDPResult, SDPMessage]

  a GstSdp.SDPResult

dump

• dump(): SDPResult

  Dump the parsed contents of msg to stdout.

  Returns SDPResult

  a GstSdp.SDPResult.

emails_len

• emails_len(): number

  Get the number of emails in msg.

  Returns number

  the number of emails in msg.

free

• free(): SDPResult

  Free all resources allocated by msg. msg should not be used anymore after this function. This function should be used when msg was dynamically allocated with gst_sdp_message_new().

  Returns SDPResult

  a GstSdp.SDPResult.

get_attribute

• get_attribute(idx: number): SDPAttribute

  Get the attribute at position idx in msg.

  Parameters

  • idx: number

    the index

  Returns SDPAttribute

  the GstSdp.SDPAttribute at position idx.

get_attribute_val

• get_attribute_val(key: string): string

  Get the first attribute with key key in msg.

  Parameters

  • key: string

    the key

  Returns string

  the attribute value of the first attribute with key.

get_attribute_val_n

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

  Get the nth attribute with key key in msg.

  Parameters

  • key: string

    the key

  • nth: number

    the index

  Returns string

  the attribute value of the nth attribute with key.

get_bandwidth

• get_bandwidth(idx: number): SDPBandwidth

  Get the bandwidth at index idx from msg.

  Parameters

  • idx: number

    the bandwidth index

  Returns SDPBandwidth

  a GstSdp.SDPBandwidth.

get_connection

• get_connection(): SDPConnection

  Get the connection of msg.

  Returns SDPConnection

  a GstSdp.SDPConnection. The result remains valid as long as msg is valid.

get_email

• get_email(idx: number): string

  Get the email with number idx from msg.

  Parameters

  • idx: number

    an email index

  Returns string

  the email at position idx.

get_information

• get_information(): string

  Get the information in msg.

  Returns string

  a GstSdp.SDPResult.

get_key

• get_key(): SDPKey

  Get the encryption information from msg.

  Returns SDPKey

  a GstSdp.SDPKey.

get_media

• get_media(idx: number): SDPMedia

  Get the media description at index idx in msg.

  Parameters

  • idx: number

    the index

  Returns SDPMedia

  a GstSdp.SDPMedia.

get_origin

• get_origin(): SDPOrigin

  Get the origin of msg.

  Returns SDPOrigin

  a GstSdp.SDPOrigin. The result remains valid as long as msg is valid.

get_phone

• get_phone(idx: number): string

  Get the phone with number idx from msg.

  Parameters

  • idx: number

    a phone index

  Returns string

  the phone at position idx.

get_session_name

• get_session_name(): string

  Get the session name in msg.

  Returns string

  a GstSdp.SDPResult.

get_time

• get_time(idx: number): SDPTime

  Get time information with index idx from msg.

  Parameters

  • idx: number

    the time index

  Returns SDPTime

  a GstSdp.SDPTime.

get_uri

• get_uri(): string

  Get the URI in msg.

  Returns string

  a GstSdp.SDPResult.

get_version

• get_version(): string

  Get the version in msg.

  Returns string

  a GstSdp.SDPResult.

get_zone

• get_zone(idx: number): SDPZone

  Get time zone information with index idx from msg.

  Parameters

  • idx: number

    the zone index

  Returns SDPZone

  a GstSdp.SDPZone.

insert_attribute

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

  Insert attribute into the array of attributes in msg at index idx. When -1 is given as idx, the attribute is inserted at the end.

  Parameters

  • idx: number

    an index

  • attr: SDPAttribute

    a GstSdp.SDPAttribute

  Returns SDPResult

  a GstSdp.SDPResult.

insert_bandwidth

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

  Insert bandwidth parameters into the array of bandwidths in msg at index idx. When -1 is given as idx, the bandwidth is inserted at the end.

  Parameters

  • idx: number

    an index

  • bw: SDPBandwidth

    the bandwidth

  Returns SDPResult

  a GstSdp.SDPResult.

insert_email

• insert_email(idx: number, email: string): SDPResult

  Insert email into the array of emails in msg at index idx. When -1 is given as idx, the email is inserted at the end.

  Parameters

  • idx: number

    an index

  • email: string

    an email

  Returns SDPResult

  a GstSdp.SDPResult.

insert_phone

• insert_phone(idx: number, phone: string): SDPResult

  Insert phone into the array of phone numbers in msg at index idx. When -1 is given as idx, the phone is inserted at the end.

  Parameters

  • idx: number

    a phone index

  • phone: string

    a phone

  Returns SDPResult

  a GstSdp.SDPResult.

insert_time

• insert_time(idx: number, t: SDPTime): SDPResult

  Insert time parameters into the array of times in msg at index idx. When -1 is given as idx, the times are inserted at the end.

  Parameters

  • idx: number

    an index

  • t: SDPTime

    a GstSdp.SDPTime

  Returns SDPResult

  a GstSdp.SDPResult.

insert_zone

• insert_zone(idx: number, zone: SDPZone): SDPResult

  Insert zone parameters into the array of zones in msg at index idx. When -1 is given as idx, the zone is inserted at the end.

  Parameters

  • idx: number

    an index

  • zone: SDPZone

    a GstSdp.SDPZone

  Returns SDPResult

  a GstSdp.SDPResult.

medias_len

• medias_len(): number

  Get the number of media descriptions in msg.

  Returns number

  the number of media descriptions in msg.

parse_keymgmt

• parse_keymgmt(): [SDPResult, MIKEYMessage]

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

  Returns [SDPResult, MIKEYMessage]

  a GstSdp.SDPResult.

phones_len

• phones_len(): number

  Get the number of phones in msg.

  Returns number

  the number of phones in msg.

remove_attribute

• remove_attribute(idx: number): SDPResult

  Remove the attribute in msg at index idx.

  Parameters

  • idx: number

    the index

  Returns SDPResult

  a GstSdp.SDPResult.

remove_bandwidth

• remove_bandwidth(idx: number): SDPResult

  Remove the bandwidth information in msg at index idx.

  Parameters

  • idx: number

    the bandwidth index

  Returns SDPResult

  a GstSdp.SDPResult.

remove_email

• remove_email(idx: number): SDPResult

  Remove the email in msg at index idx.

  Parameters

  • idx: number

    an email index

  Returns SDPResult

  a GstSdp.SDPResult.

remove_media

• remove_media(idx: number): SDPResult

  Remove the media at idx from the array of medias in msg if found.

  Parameters

  • idx: number

    the media index

  Returns SDPResult

  #GST_SDP_OK when the specified media is found at idx and removed, #GST_SDP_EINVAL otherwise.

remove_phone

• remove_phone(idx: number): SDPResult

  Remove the phone number in msg at index idx.

  Parameters

  • idx: number

    a phone index

  Returns SDPResult

  a GstSdp.SDPResult.

remove_time

• remove_time(idx: number): SDPResult

  Remove the time information in msg at index idx.

  Parameters

  • idx: number

    the index

  Returns SDPResult

  a GstSdp.SDPResult.

remove_zone

• remove_zone(idx: number): SDPResult

  Remove the zone information in msg at index idx.

  Parameters

  • idx: number

    the index

  Returns SDPResult

  a GstSdp.SDPResult.

replace_attribute

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

  Replace the attribute in msg at index idx with attr.

  Parameters

  • idx: number

    the index

  • attr: SDPAttribute

    a GstSdp.SDPAttribute

  Returns SDPResult

  a GstSdp.SDPResult.

replace_bandwidth

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

  Replace the bandwidth information in msg at index idx with bw.

  Parameters

  • idx: number

    the bandwidth index

  • bw: SDPBandwidth

    the bandwidth

  Returns SDPResult

  a GstSdp.SDPResult.

replace_email

• replace_email(idx: number, email: string): SDPResult

  Replace the email in msg at index idx with email.

  Parameters

  • idx: number

    an email index

  • email: string

    an email

  Returns SDPResult

  a GstSdp.SDPResult.

replace_phone

• replace_phone(idx: number, phone: string): SDPResult

  Replace the phone number in msg at index idx with phone.

  Parameters

  • idx: number

    a phone index

  • phone: string

    a phone

  Returns SDPResult

  a GstSdp.SDPResult.

replace_time

• replace_time(idx: number, t: SDPTime): SDPResult

  Replace the time information in msg at index idx with t.

  Parameters

  • idx: number

    the index

  • t: SDPTime

    a GstSdp.SDPTime

  Returns SDPResult

  a GstSdp.SDPResult.

replace_zone

• replace_zone(idx: number, zone: SDPZone): SDPResult

  Replace the zone information in msg at index idx with zone.

  Parameters

  • idx: number

    the index

  • zone: SDPZone

    a GstSdp.SDPZone

  Returns SDPResult

  a GstSdp.SDPResult.

set_connection

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

  Configure the SDP connection in msg with the given parameters.

  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.

set_information

• set_information(information: string): SDPResult

  Set the information in msg.

  Parameters

  • information: string

    the information

  Returns SDPResult

  a GstSdp.SDPResult.

set_key

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

  Adds the encryption information to msg.

  Parameters

  • type: string

    the encryption type

  • data: string

    the encryption data

  Returns SDPResult

  a GstSdp.SDPResult.

set_origin

• set_origin(
      username: string,
      sess_id: string,
      sess_version: string,
      nettype: string,
      addrtype: string,
      addr: string,
  ): SDPResult

  Configure the SDP origin in msg with the given parameters.

  Parameters

  • username: string

    the user name

  • sess_id: string

    a session id

  • sess_version: string

    a session version

  • nettype: string

    a network type

  • addrtype: string

    an address type

  • addr: string

    an address

  Returns SDPResult

  #GST_SDP_OK.

set_session_name

• set_session_name(session_name: string): SDPResult

  Set the session name in msg.

  Parameters

  • session_name: string

    the session name

  Returns SDPResult

  a GstSdp.SDPResult.

set_uri

• set_uri(uri: string): SDPResult

  Set the URI in msg.

  Parameters

  • uri: string

    the URI

  Returns SDPResult

  a GstSdp.SDPResult.

set_version

• set_version(version: string): SDPResult

  Set the version in msg.

  Parameters

  • version: string

    the version

  Returns SDPResult

  a GstSdp.SDPResult.

times_len

• times_len(): number

  Get the number of time information entries in msg.

  Returns number

  the number of time information entries in msg.

uninit

• uninit(): SDPResult

  Free all resources allocated in msg. msg should not be used anymore after this function. This function should be used when msg was allocated on the stack and initialized with gst_sdp_message_init().

  Returns SDPResult

  a GstSdp.SDPResult.

zones_len

• zones_len(): number

  Get the number of time zone information entries in msg.

  Returns number

  the number of time zone information entries in msg.

Staticas_uri

• as_uri(scheme: string, msg: SDPMessage): string

  Creates a uri from msg with the given scheme. The uri has the format:

  scheme:///[#type=value *[&type=value]]

  Where each value is url encoded.

  Parameters

  • scheme: string

    the uri scheme

  • msg: SDPMessage

    the GstSdp.SDPMessage

  Returns string

Staticinit

• init(): [SDPResult, SDPMessage]

  Initialize msg so that its contents are as if it was freshly allocated with gst_sdp_message_new(). This function is mostly used to initialize a message allocated on the stack. gst_sdp_message_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, SDPMessage]

Staticnew

• new(): [SDPResult, SDPMessage]

  Allocate a new GstSDPMessage and store the result in msg.

  Returns [SDPResult, SDPMessage]

Staticnew_from_text

• new_from_text(text: string): [SDPResult, SDPMessage]

  Parse text and create a new SDPMessage from these.

  Parameters

  • text: string

    A dynamically allocated string representing the SDP description

  Returns [SDPResult, SDPMessage]

Staticparse_buffer

• parse_buffer(
      data: string | Uint8Array<ArrayBufferLike>,
      msg: SDPMessage,
  ): SDPResult

  Parse the contents of size bytes pointed to by data and store the result in msg.

  Parameters

  • data: string | Uint8Array<ArrayBufferLike>

    the start of the buffer

  • msg: SDPMessage

    the result GstSdp.SDPMessage

  Returns SDPResult

Staticparse_uri

• parse_uri(uri: string, msg: SDPMessage): SDPResult

  Parse the null-terminated uri and store the result in msg.

  The uri should be of the form:

  scheme://[address[:ttl=ttl][:noa=noa]]/[sessionname] [#type=value *[&type=value]]

  where value is url encoded. This looslely resembles http://tools.ietf.org/html/draft-fujikawa-sdp-url-01

  Parameters

  • uri: string

    the start of the uri

  • msg: SDPMessage

    the result GstSdp.SDPMessage

  Returns SDPResult