Class MIKEYMessage

Structure holding the information of the MIKEY message

record

Hierarchy

MIKEYMessage

Constructors

constructor

new MIKEYMessage(): MIKEYMessage

- Defined in GstSdp-1.0.d.ts:658
Make a new MIKEY message.

Returns MIKEYMessage

Properties

cSBId

cSBId: number

Identifies the Crypto Session Bundle

field

mapInfo

mapInfo: object[]

map info array of type depending on map_type

field

mapType

mapType: MIKEYMapType

a #GstMIKEYMapType

field

payloads

payloads: object[]

the payload array of #GstMIKEYPayload

field

prfFunc

prfFunc: MIKEYPRFFunc

a #GstMIKEYPRFFunc

field

type

type: MIKEYType

the #GstMIKEYType message type

field

v

v: boolean

verify flag

field

version

version: number

the version

field

Static name

name: string

Methods

addCsSrtp

addCsSrtp(policy: number, ssrc: number, roc: number): boolean

- Defined in GstSdp-1.0.d.ts:529
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

addPayload

addPayload(payload: MIKEYPayload): boolean

- Defined in GstSdp-1.0.d.ts:534
Add a new payload to msg.

Parameters
- payload: MIKEYPayload
  
  a #GstMIKEYPayload
Returns boolean

addPke

addPke(c: MIKEYCacheType, data: Uint8Array): boolean

- Defined in GstSdp-1.0.d.ts:540
Add a new PKE payload to msg with the given parameters.

Parameters
- c: MIKEYCacheType
  
  envelope key cache indicator
- data: Uint8Array
  
  the encrypted envelope key
Returns boolean

addRand

addRand(rand: Uint8Array): boolean

- Defined in GstSdp-1.0.d.ts:545
Add a new RAND payload to msg with the given parameters.

Parameters
- rand: Uint8Array
  
  random data
Returns boolean

addRandLen

addRandLen(len: number): boolean

- Defined in GstSdp-1.0.d.ts:550
Add a new RAND payload to msg with len random bytes.

Parameters
- len: number
  
  length
Returns boolean

addT

addT(type: MIKEYTSType, tsValue: Uint8Array): boolean

- Defined in GstSdp-1.0.d.ts:556
Add a new T payload to msg with the given parameters.

Parameters
- type: MIKEYTSType
  
  specifies the timestamp type used
- tsValue: Uint8Array
  
  The timestamp value of the specified type
Returns boolean

addTNowNtpUtc

addTNowNtpUtc(): boolean

- Defined in GstSdp-1.0.d.ts:561
Add a new T payload to msg that contains the current time in NTP-UTC format.

Returns boolean

base64Encode

base64Encode(): string

- Defined in GstSdp-1.0.d.ts:562
Returns string

findPayload

findPayload(type: MIKEYPayloadType, nth: number): MIKEYPayload

- Defined in GstSdp-1.0.d.ts:568
Find the nth occurrence of the payload with type in msg.

Parameters
- type: MIKEYPayloadType
  
  a #GstMIKEYPayloadType
- nth: number
  
  payload to find
Returns MIKEYPayload

getCsSrtp

getCsSrtp(idx: number): MIKEYMapSRTP

- Defined in GstSdp-1.0.d.ts:573
Get the policy information of msg at idx.

Parameters
- idx: number
  
  an index
Returns MIKEYMapSRTP

getNCs

getNCs(): number

- Defined in GstSdp-1.0.d.ts:577
Get the number of crypto sessions in msg.

Returns number

getNPayloads

getNPayloads(): number

- Defined in GstSdp-1.0.d.ts:581
Get the number of payloads in msg.

Returns number

getPayload

getPayload(idx: number): MIKEYPayload

- Defined in GstSdp-1.0.d.ts:586
Get the #GstMIKEYPayload at idx in msg

Parameters
- idx: number
  
  an index
Returns MIKEYPayload

insertCsSrtp

insertCsSrtp(idx: number, map: MIKEYMapSRTP): boolean

- Defined in GstSdp-1.0.d.ts:594
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

insertPayload

insertPayload(idx: number, payload: MIKEYPayload): boolean

- Defined in GstSdp-1.0.d.ts:601
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

removeCsSrtp

removeCsSrtp(idx: number): boolean

- Defined in GstSdp-1.0.d.ts:606
Remove the SRTP policy at idx.

Parameters
- idx: number
  
  the index to remove
Returns boolean

removePayload

removePayload(idx: number): boolean

- Defined in GstSdp-1.0.d.ts:611
Remove the payload in msg at idx

Parameters
- idx: number
  
  an index
Returns boolean

replaceCsSrtp

replaceCsSrtp(idx: number, map: MIKEYMapSRTP): boolean

- Defined in GstSdp-1.0.d.ts:617
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

replacePayload

replacePayload(idx: number, payload: MIKEYPayload): boolean

- Defined in GstSdp-1.0.d.ts:623
Replace the payload at idx in msg with payload.

Parameters
- idx: number
  
  an index
- payload: MIKEYPayload
  
  a #GstMIKEYPayload
Returns boolean

setInfo

setInfo(version: number, type: MIKEYType, v: boolean, prfFunc: MIKEYPRFFunc, cSBId: number, mapType: MIKEYMapType): boolean

- Defined in GstSdp-1.0.d.ts:633
Set the information in msg.

Parameters
- version: number
  
  a version
- type: MIKEYType
  
  a #GstMIKEYType
- v: boolean
  
  verify flag
- prfFunc: MIKEYPRFFunc
  
  the #GstMIKEYPRFFunc function to use
- cSBId: number
  
  the Crypto Session Bundle id
- mapType: MIKEYMapType
  
  the #GstMIKEYMapType
Returns boolean

toBytes

toBytes(info: MIKEYEncryptInfo): any

- Defined in GstSdp-1.0.d.ts:638
Convert msg to a #GBytes.

Parameters
- info: MIKEYEncryptInfo
  
  a #GstMIKEYEncryptInfo
Returns any

toCaps

toCaps(caps: Gst.Caps): boolean

- Defined in GstSdp-1.0.d.ts:639
Parameters
- caps: Gst.Caps
Returns boolean

Static new

new(): MIKEYMessage

- Defined in GstSdp-1.0.d.ts:663
Make a new MIKEY message.

Returns MIKEYMessage

Static newFromBytes

newFromBytes(bytes: any, info: MIKEYDecryptInfo): MIKEYMessage

- Defined in GstSdp-1.0.d.ts:670
Make a new #GstMIKEYMessage from bytes.

Parameters
- bytes: any
  
  a #GBytes
- info: MIKEYDecryptInfo
  
  a #GstMIKEYDecryptInfo
Returns MIKEYMessage

Static newFromCaps

newFromCaps(caps: Gst.Caps): MIKEYMessage

- Defined in GstSdp-1.0.d.ts:679
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

Static newFromData

newFromData(data: Uint8Array, info: MIKEYDecryptInfo): MIKEYMessage

- Defined in GstSdp-1.0.d.ts:687
Parse size bytes from data into a #GstMIKEYMessage. info contains the parameters to decrypt and verify the data.

Parameters
- data: Uint8Array
  
  bytes to read
- info: MIKEYDecryptInfo
  
  #GstMIKEYDecryptInfo
Returns MIKEYMessage