Gjsify LogoGjsify Logo

Hold the common fields for all payloads

record

Hierarchy

  • MIKEYPayload

Index

Constructors

Properties

len: number

length of the payload

field

the payload type

field
name: string

Methods

  • kemacGetNSub(): number
  • Get the number of sub payloads of payload. payload should be of type %GST_MIKEY_PT_KEMAC.

    Returns number

  • Get the sub payload of payload at idx. payload should be of type %GST_MIKEY_PT_KEMAC.

    Parameters

    • idx: number

      an index

    Returns MIKEYPayload

  • kemacRemoveSub(idx: number): boolean
  • Remove the sub payload at idx in payload.

    Parameters

    • idx: number

      the index to remove

    Returns boolean

  • Set the KEMAC parameters. payload should point to a %GST_MIKEY_PT_KEMAC payload.

    Parameters

    Returns boolean

  • keyDataSetInterval(vfLen: number, vtData: Uint8Array): boolean
  • Set the key validity period in the %GST_MIKEY_PT_KEY_DATA payload.

    Parameters

    • vfLen: number

      the length of vf_data

    • vtData: Uint8Array

      the Valid To data

    Returns boolean

  • Set key_len bytes of key_data of type key_type as the key for the %GST_MIKEY_PT_KEY_DATA payload.

    Parameters

    • keyType: MIKEYKeyDataType

      a #GstMIKEYKeyDataType

    • keyData: Uint8Array

      the key of type key_type

    Returns boolean

  • keyDataSetSalt(saltData: Uint8Array): boolean
  • Set the salt key data. If salt_len is 0 and salt_data is %NULL, the salt data will be removed.

    Parameters

    • saltData: Uint8Array

      the salt

    Returns boolean

  • keyDataSetSpi(spiData: Uint8Array): boolean
  • Set the SPI/MKI validity in the %GST_MIKEY_PT_KEY_DATA payload.

    Parameters

    • spiData: Uint8Array

      the SPI/MKI data

    Returns boolean

  • Set the PKE values in payload. payload must be of type %GST_MIKEY_PT_PKE.

    Parameters

    • c: MIKEYCacheType

      envelope key cache indicator

    • data: Uint8Array

      the encrypted envelope key

    Returns boolean

  • randSet(rand: Uint8Array): boolean
  • Set the random values in a %GST_MIKEY_PT_RAND payload.

    Parameters

    • rand: Uint8Array

      random values

    Returns boolean

  • spAddParam(type: number, val: Uint8Array): boolean
  • Add a new parameter to the %GST_MIKEY_PT_SP payload with type, len and val.

    Parameters

    • type: number

      a type

    • val: Uint8Array

      len bytes of data

    Returns boolean

  • spGetNParams(): number
  • Get the number of security policy parameters in a %GST_MIKEY_PT_SP payload.

    Returns number

  • spRemoveParam(idx: number): boolean
  • Remove the Security Policy parameters from a %GST_MIKEY_PT_SP payload at idx.

    Parameters

    • idx: number

      an index

    Returns boolean

  • Set the Security Policy parameters for payload.

    Parameters

    • policy: number

      the policy number

    • proto: MIKEYSecProto

      a #GstMIKEYSecProto

    Returns boolean

  • Set the timestamp in a %GST_MIKEY_PT_T payload.

    Parameters

    • type: MIKEYTSType

      the #GstMIKEYTSType

    • tsValue: Uint8Array

      the timestamp value

    Returns boolean

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