Gjsify LogoGjsify Logo

Structure holding the information of the MIKEY message

record

Hierarchy

  • MIKEYMessage

Index

Constructors

Properties

CSB_id: number

Identifies the Crypto Session Bundle

field
V: boolean

verify flag

field
map_info: object[]

map info array of type depending on map_type

field
map_type: MIKEYMapType

a #GstMIKEYMapType

field
payloads: object[]

the payload array of #GstMIKEYPayload

field
prf_func: MIKEYPRFFunc

a #GstMIKEYPRFFunc

field
type: MIKEYType

the #GstMIKEYType message type

field
version: number

the version

field
name: string

Methods

  • 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

  • add_rand(rand: Uint8Array): boolean
  • Add a new RAND payload to msg with the given parameters.

    Parameters

    • rand: Uint8Array

      random data

    Returns boolean

  • add_rand_len(len: number): boolean
  • add_t(type: MIKEYTSType, ts_value: Uint8Array): boolean
  • Add a new T payload to msg with the given parameters.

    Parameters

    • type: MIKEYTSType

      specifies the timestamp type used

    • ts_value: Uint8Array

      The timestamp value of the specified type

    Returns boolean

  • add_t_now_ntp_utc(): boolean
  • base64_encode(): string
  • get_n_cs(): number
  • get_n_payloads(): number
  • 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

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

    Returns boolean

  • remove_cs_srtp(idx: number): boolean
  • remove_payload(idx: number): boolean
  • replace_payload(idx: number, payload: MIKEYPayload): boolean
  • Set the information in msg.

    Parameters

    • version: number

      a version

    • type: MIKEYType

      a #GstMIKEYType

    • V: boolean

      verify flag

    • prf_func: MIKEYPRFFunc

      the #GstMIKEYPRFFunc function to use

    • CSB_id: number

      the Crypto Session Bundle id

    • map_type: MIKEYMapType

      the #GstMIKEYMapType

    Returns boolean

  • Makes mikey message including:

    • Security Policy Payload
    • Key Data Transport Payload
    • Key Data Sub-Payload

    Parameters

    • caps: Gst.Caps

      a #GstCaps, including SRTP parameters (srtp/srtcp cipher, authorization, key data)

    Returns MIKEYMessage

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