GstSdp-1.0 ▶ GstSdp ▶ MIKEYMessage

constructor

• new MIKEYMessage(
      properties?: Partial<
          {
              CSB_id: number;
              map_info: null[];
              map_type: MIKEYMapType;
              payloads: null[];
              prf_func: MIKEYPRFFunc;
              type: MIKEYType;
              V: boolean;
              version: number;
          },
      >,
  ): MIKEYMessage

  Parameters

  • Optionalproperties: Partial<
        {
            CSB_id: number;
            map_info: null[];
            map_type: MIKEYMapType;
            payloads: null[];
            prf_func: MIKEYPRFFunc;
            type: MIKEYType;
            V: boolean;
            version: number;
        },
    >

  Returns MIKEYMessage

CSB_id

map_info

map_type

payloads

prf_func

type

V

version

Static$gtype

Since 1.4add_cs_srtp

• add_cs_srtp(policy: number, ssrc: number, roc: number): boolean

  Add a Crypto policy for SRTP to msg.

  Parameters

  • policy: number

    The security policy applied for the stream with ssrc

  • ssrc: number

    the SSRC that must be used for the stream

  • roc: number

    current rollover counter

  Returns boolean

  true on success

  Since

  1.4

Since 1.4add_payload

• add_payload(payload: MIKEYPayload): boolean

  Add a new payload to msg.

  Parameters

  • payload: MIKEYPayload

    a GstSdp.MIKEYPayload

  Returns boolean

  true on success

  Since

  1.4

Since 1.4add_pke

• add_pke(C: MIKEYCacheType, data: string | Uint8Array<ArrayBufferLike>): boolean

  Add a new PKE payload to msg with the given parameters.

  Parameters

  • C: MIKEYCacheType

    envelope key cache indicator

  • data: string | Uint8Array<ArrayBufferLike>

    the encrypted envelope key

  Returns boolean

  true on success

  Since

  1.4

Since 1.4add_rand

• add_rand(rand: string | Uint8Array<ArrayBufferLike>): boolean

  Add a new RAND payload to msg with the given parameters.

  Parameters

  • rand: string | Uint8Array<ArrayBufferLike>

    random data

  Returns boolean

  true on success

  Since

  1.4

Since 1.4add_rand_len

• add_rand_len(len: number): boolean

  Add a new RAND payload to msg with len random bytes.

  Parameters

  • len: number

    length

  Returns boolean

  true on success

  Since

  1.4

Since 1.4add_t

• add_t(
      type: MIKEYTSType,
      ts_value: string | Uint8Array<ArrayBufferLike>,
  ): boolean

  Add a new T payload to msg with the given parameters.

  Parameters

  • type: MIKEYTSType

    specifies the timestamp type used

  • ts_value: string | Uint8Array<ArrayBufferLike>

    The timestamp value of the specified type

  Returns boolean

  true on success

  Since

  1.4

Since 1.4add_t_now_ntp_utc

• add_t_now_ntp_utc(): boolean

  Add a new T payload to msg that contains the current time in NTP-UTC format.

  Returns boolean

  true on success

  Since

  1.4

Since 1.8base64_encode

• base64_encode(): string

  Returns string

  a gchar, base64-encoded data

  Since

  1.8

Since 1.4find_payload

• find_payload(type: MIKEYPayloadType, nth: number): MIKEYPayload

  Find the nth occurrence of the payload with type in msg.

  Parameters

  • type: MIKEYPayloadType

    a GstSdp.MIKEYPayloadType

  • nth: number

    payload to find

  Returns MIKEYPayload

  the nth GstSdp.MIKEYPayload of type.

  Since

  1.4

Since 1.4get_cs_srtp

• get_cs_srtp(idx: number): MIKEYMapSRTP

  Get the policy information of msg at idx.

  Parameters

  • idx: number

    an index

  Returns MIKEYMapSRTP

  a GstSdp.MIKEYMapSRTP

  Since

  1.4

Since 1.4get_n_cs

• get_n_cs(): number

  Get the number of crypto sessions in msg.

  Returns number

  the number of crypto sessions

  Since

  1.4

Since 1.4get_n_payloads

• get_n_payloads(): number

  Get the number of payloads in msg.

  Returns number

  the number of payloads in msg

  Since

  1.4

Since 1.4get_payload

• get_payload(idx: number): MIKEYPayload

  Get the GstSdp.MIKEYPayload at idx in msg

  Parameters

  • idx: number

    an index

  Returns MIKEYPayload

  the GstSdp.MIKEYPayload at idx. The payload remains valid for as long as it is part of msg.

  Since

  1.4

Since 1.4insert_cs_srtp

• insert_cs_srtp(idx: number, map: MIKEYMapSRTP): boolean

  Insert a Crypto Session map for SRTP in msg at idx

  When idx is -1, the policy will be appended.

  Parameters

  • idx: number

    the index to insert at

  • map: MIKEYMapSRTP

    the map info

  Returns boolean

  true on success

  Since

  1.4

Since 1.4insert_payload

• insert_payload(idx: number, payload: MIKEYPayload): boolean

  Insert the payload at index idx in msg. If idx is -1, the payload will be appended to msg.

  Parameters

  • idx: number

    an index

  • payload: MIKEYPayload

    a GstSdp.MIKEYPayload

  Returns boolean

  true on success

  Since

  1.4

Since 1.4remove_cs_srtp

• remove_cs_srtp(idx: number): boolean

  Remove the SRTP policy at idx.

  Parameters

  • idx: number

    the index to remove

  Returns boolean

  true on success

  Since

  1.4

Since 1.4remove_payload

• remove_payload(idx: number): boolean

  Remove the payload in msg at idx

  Parameters

  • idx: number

    an index

  Returns boolean

  true on success

  Since

  1.4

Since 1.4replace_cs_srtp

• replace_cs_srtp(idx: number, map: MIKEYMapSRTP): boolean

  Replace a Crypto Session map for SRTP in msg at idx with map.

  Parameters

  • idx: number

    the index to insert at

  • map: MIKEYMapSRTP

    the map info

  Returns boolean

  true on success

  Since

  1.4

Since 1.4replace_payload

• replace_payload(idx: number, payload: MIKEYPayload): boolean

  Replace the payload at idx in msg with payload.

  Parameters

  • idx: number

    an index

  • payload: MIKEYPayload

    a GstSdp.MIKEYPayload

  Returns boolean

  true on success

  Since

  1.4

Since 1.4set_info

• set_info(
      version: number,
      type: MIKEYType,
      V: boolean,
      prf_func: MIKEY_PRF_MIKEY_1,
      CSB_id: number,
      map_type: MIKEY_MAP_TYPE_SRTP,
  ): boolean

  Set the information in msg.

  Parameters

  • version: number

    a version

  • type: MIKEYType

    a GstSdp.MIKEYType

  • V: boolean

    verify flag

  • prf_func: MIKEY_PRF_MIKEY_1

    the GstSdp.MIKEYPRFFunc function to use

  • CSB_id: number

    the Crypto Session Bundle id

  • map_type: MIKEY_MAP_TYPE_SRTP

    the GstSdp.MIKEYMapType

  Returns boolean

  true on success

  Since

  1.4

Since 1.4to_bytes

• to_bytes(info: MIKEYEncryptInfo): GLib.Bytes

  Convert msg to a GLib.Bytes.

  Parameters

  • info: MIKEYEncryptInfo

    a GstSdp.MIKEYEncryptInfo

  Returns GLib.Bytes

  a new GLib.Bytes for msg.

  Since

  1.4

  Throws

  GLib.Error

Since 1.8.1to_caps

• to_caps(caps: Gst.Caps): boolean

  Parameters

  • caps: Gst.Caps

    a Gst.Caps to be filled with SRTP parameters (srtp/srtcp cipher, authorization, key data)

  Returns boolean

  true on success

  Since

  1.8.1

Staticnew

• new(): MIKEYMessage

  Returns MIKEYMessage

Staticnew_from_bytes

• new_from_bytes(
      bytes: Uint8Array<ArrayBufferLike> | GLib.Bytes,
      info: MIKEYDecryptInfo,
  ): MIKEYMessage

  Parameters

  • bytes: Uint8Array<ArrayBufferLike> | GLib.Bytes
  • info: MIKEYDecryptInfo

  Returns MIKEYMessage

Staticnew_from_caps

• new_from_caps(caps: Gst.Caps): MIKEYMessage

  Parameters

  • caps: Gst.Caps

  Returns MIKEYMessage

Staticnew_from_data

• new_from_data(
      data: string | Uint8Array<ArrayBufferLike>,
      info: MIKEYDecryptInfo,
  ): MIKEYMessage

  Parameters

  • data: string | Uint8Array<ArrayBufferLike>
  • info: MIKEYDecryptInfo

  Returns MIKEYMessage