GstSdp-1.0 ▶ GstSdp ▶ MIKEYPayload

constructor

• new MIKEYPayload(type: MIKEYPayloadType): MIKEYPayload

  Parameters

  • type: MIKEYPayloadType

  Returns MIKEYPayload

len

type

Static$gtype

Since 1.4kemac_add_sub

• kemac_add_sub(newpay: MIKEYPayload): boolean

  Add a new sub payload to payload.

  Parameters

  • newpay: MIKEYPayload

    a GstSdp.MIKEYPayload to add

  Returns boolean

  true on success.

  Since

  1.4

Since 1.4kemac_get_n_sub

• kemac_get_n_sub(): number

  Get the number of sub payloads of payload. payload should be of type GstSdp.MIKEYPayloadType.KEMAC.

  Returns number

  the number of sub payloads in payload

  Since

  1.4

Since 1.4kemac_get_sub

• kemac_get_sub(idx: number): MIKEYPayload

  Get the sub payload of payload at idx. payload should be of type GstSdp.MIKEYPayloadType.KEMAC.

  Parameters

  • idx: number

    an index

  Returns MIKEYPayload

  the GstSdp.MIKEYPayload at idx.

  Since

  1.4

Since 1.4kemac_remove_sub

• kemac_remove_sub(idx: number): boolean

  Remove the sub payload at idx in payload.

  Parameters

  • idx: number

    the index to remove

  Returns boolean

  true on success.

  Since

  1.4

Since 1.4kemac_set

• kemac_set(enc_alg: MIKEYEncAlg, mac_alg: MIKEYMacAlg): boolean

  Set the KEMAC parameters. payload should point to a GstSdp.MIKEYPayloadType.KEMAC payload.

  Parameters

  • enc_alg: MIKEYEncAlg

    the GstSdp.MIKEYEncAlg

  • mac_alg: MIKEYMacAlg

    a GstSdp.MIKEYMacAlg

  Returns boolean

  true on success

  Since

  1.4

Since 1.4key_data_set_interval

• key_data_set_interval(
      vf_data: string | Uint8Array<ArrayBufferLike>,
      vt_data: string | Uint8Array<ArrayBufferLike>,
  ): boolean

  Set the key validity period in the GstSdp.MIKEYPayloadType.KEY_DATA payload.

  Parameters

  • vf_data: string | Uint8Array<ArrayBufferLike>

    the Valid From data

  • vt_data: string | Uint8Array<ArrayBufferLike>

    the Valid To data

  Returns boolean

  true on success

  Since

  1.4

Since 1.4key_data_set_key

• key_data_set_key(
      key_type: MIKEYKeyDataType,
      key_data: string | Uint8Array<ArrayBufferLike>,
  ): boolean

  Set key_len bytes of key_data of type key_type as the key for the GstSdp.MIKEYPayloadType.KEY_DATA payload.

  Parameters

  • key_type: MIKEYKeyDataType

    a GstSdp.MIKEYKeyDataType

  • key_data: string | Uint8Array<ArrayBufferLike>

    the key of type key_type

  Returns boolean

  true on success

  Since

  1.4

Since 1.4key_data_set_salt

• key_data_set_salt(salt_data: string | Uint8Array<ArrayBufferLike>): boolean

  Set the salt key data. If salt_len is 0 and salt_data is null, the salt data will be removed.

  Parameters

  • salt_data: string | Uint8Array<ArrayBufferLike>

    the salt

  Returns boolean

  true on success

  Since

  1.4

Since 1.4key_data_set_spi

• key_data_set_spi(spi_data: string | Uint8Array<ArrayBufferLike>): boolean

  Set the SPI/MKI validity in the GstSdp.MIKEYPayloadType.KEY_DATA payload.

  Parameters

  • spi_data: string | Uint8Array<ArrayBufferLike>

    the SPI/MKI data

  Returns boolean

  true on success

  Since

  1.4

Since 1.4pke_set

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

  Set the PKE values in payload. payload must be of type GstSdp.MIKEYPayloadType.PKE.

  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.4rand_set

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

  Set the random values in a GstSdp.MIKEYPayloadType.RAND payload.

  Parameters

  • rand: string | Uint8Array<ArrayBufferLike>

    random values

  Returns boolean

  true on success

  Since

  1.4

Since 1.4sp_add_param

• sp_add_param(type: number, val: string | Uint8Array<ArrayBufferLike>): boolean

  Add a new parameter to the GstSdp.MIKEYPayloadType.SP payload with type, len and val.

  Parameters

  • type: number

    a type

  • val: string | Uint8Array<ArrayBufferLike>

    len bytes of data

  Returns boolean

  true on success

  Since

  1.4

Since 1.4sp_get_n_params

• sp_get_n_params(): number

  Get the number of security policy parameters in a GstSdp.MIKEYPayloadType.SP payload.

  Returns number

  the number of parameters in payload

  Since

  1.4

Since 1.4sp_get_param

• sp_get_param(idx: number): MIKEYPayloadSPParam

  Get the Security Policy parameter in a GstSdp.MIKEYPayloadType.SP payload at idx.

  Parameters

  • idx: number

    an index

  Returns MIKEYPayloadSPParam

  the GstSdp.MIKEYPayloadSPParam at idx in payload

  Since

  1.4

Since 1.4sp_remove_param

• sp_remove_param(idx: number): boolean

  Remove the Security Policy parameters from a GstSdp.MIKEYPayloadType.SP payload at idx.

  Parameters

  • idx: number

    an index

  Returns boolean

  true on success

  Since

  1.4

Since 1.4sp_set

• sp_set(policy: number, proto: MIKEY_SEC_PROTO_SRTP): boolean

  Set the Security Policy parameters for payload.

  Parameters

  • policy: number

    the policy number

  • proto: MIKEY_SEC_PROTO_SRTP

    a GstSdp.MIKEYSecProto

  Returns boolean

  true on success

  Since

  1.4

Since 1.4t_set

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

  Set the timestamp in a GstSdp.MIKEYPayloadType.T payload.

  Parameters

  • type: MIKEYTSType

    the GstSdp.MIKEYTSType

  • ts_value: string | Uint8Array<ArrayBufferLike>

    the timestamp value

  Returns boolean

  true on success

  Since

  1.4

Staticnew

• new(type: MIKEYPayloadType): MIKEYPayload

  Parameters

  • type: MIKEYPayloadType

  Returns MIKEYPayload