Gjsify LogoGjsify Logo

The GstSDPMessage helper functions makes it easy to parse and create SDP messages.

record

Hierarchy

  • SDPMessage

Index

Constructors

Properties

attributes: object[]

array of #GstSDPAttribute with session attributes

field
bandwidths: object[]

array of #GstSDPBandwidth with bandwidth information

field
connection: SDPConnection

connection information for the session

field
emails: object[]

array of #gchar with email addresses

field
information: string

session information

field
key: SDPKey

encryption key

field
medias: object[]

array of #GstSDPMedia with media descriptions

field
origin: SDPOrigin

owner/creator and session identifier

field
phones: object[]

array of #gchar with phone numbers

field
sessionName: string

session name

field
times: object[]

array of #GstSDPTime with time descriptions

field
uri: string

URI of description

field
version: string

the protocol version

field
zones: object[]

array of #GstSDPZone with time zone adjustments

field
name: string

Methods

  • addAttribute(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

  • addBandwidth(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

  • 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

    Returns SDPResult

  • addTime(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

  • addZone(adjTime: string, typedTime: string): SDPResult
  • Add time zone information to msg.

    Parameters

    • adjTime: string

      the NTP time that a time zone adjustment happens

    • typedTime: string

      the offset from the time when the session was first scheduled

    Returns SDPResult

  • asText(): string
  • attributesLen(): number
  • bandwidthsLen(): number
  • emailsLen(): number
  • 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

  • getAttributeVal(key: string): string
  • Get the first attribute with key key in msg.

    Parameters

    • key: string

      the key

    Returns string

  • getAttributeValN(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

  • getEmail(idx: number): string
  • Get the email with number idx from msg.

    Parameters

    • idx: number

      an email index

    Returns string

  • getInformation(): string
  • getPhone(idx: number): string
  • Get the phone with number idx from msg.

    Parameters

    • idx: number

      a phone index

    Returns string

  • getSessionName(): string
  • getUri(): string
  • getVersion(): string
  • Get time zone information with index idx from msg.

    Parameters

    • idx: number

      the zone index

    Returns SDPZone

  • 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

  • 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

    Returns 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

    Returns SDPResult

  • insertEmail(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

  • insertPhone(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

  • 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 #GstSDPTime

    Returns 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 #GstSDPZone

    Returns SDPResult

  • mediasLen(): number
  • phonesLen(): number
  • Remove the bandwidth information in msg at index idx.

    Parameters

    • idx: number

      the bandwidth index

    Returns SDPResult

  • replaceEmail(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

  • replacePhone(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

  • setConnection(nettype: string, addrtype: string, address: string, ttl: number, addrNumber: 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

    • addrNumber: number

      the number of layers

    Returns SDPResult

  • setInformation(information: string): SDPResult
  • setKey(type: string, data: string): SDPResult
  • Adds the encryption information to msg.

    Parameters

    • type: string

      the encryption type

    • data: string

      the encryption data

    Returns SDPResult

  • setOrigin(username: string, sessId: string, sessVersion: string, nettype: string, addrtype: string, addr: string): SDPResult
  • Configure the SDP origin in msg with the given parameters.

    Parameters

    • username: string

      the user name

    • sessId: string

      a session id

    • sessVersion: string

      a session version

    • nettype: string

      a network type

    • addrtype: string

      an address type

    • addr: string

      an address

    Returns SDPResult

  • setSessionName(sessionName: string): SDPResult
  • timesLen(): number
  • 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

  • zonesLen(): number
  • Get the number of time zone information entries in msg.

    Returns number

  • 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 #GstSDPMessage

    Returns string

  • Parse text and create a new SDPMessage from these.

    Parameters

    • text: string

      A dynamically allocated string representing the SDP description

    Returns [SDPResult, SDPMessage]

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

    Parameters

    • data: Uint8Array

      the start of the buffer

    • msg: SDPMessage

      the result #GstSDPMessage

    Returns SDPResult

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