/ fm / liveswitch / sdp / CryptoAttribute

Class: CryptoAttribute

liveswitch.sdp.CryptoAttribute

This gives the maximum amount of media that can be encapsulated in each packet, expressed as time in milliseconds. The time SHALL be calculated as the sum of the time the media present in the packet represents. For frame-based codecs, the time SHOULD be an integer multiple of the frame size. This attribute is probably only meaningful for audio data, but may be used with other media types if it makes sense. It is a media-level attribute, and it is not dependent on charset. Note that this attribute was introduced after RFC 2327, and non-updated implementations will ignore this attribute.

Hierarchy

• Attribute

  ↳ CryptoAttribute

Table of contents

Constructors

• constructor

Methods

• fmliveswitchsdpCryptoAttributeInit
• getAttributeType
• getAttributeValue
• getCryptoSuite
• getKey
• getKeyParams
• getMultiplexingCategory
• getSalt
• getSessionParams
• getTag
• getTypeString
• setAttributeType
• setKeySalt
• setMultiplexingCategory
• setTag
• toString
• createAttribute
• fromAttributeValue
• getTypeName
• isMediaLevel
• isSessionLevel
• parse

Constructors

constructor

+ new CryptoAttribute(): CryptoAttribute

Returns: CryptoAttribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:34

+ new CryptoAttribute(tag: number, cryptoSuite: string): CryptoAttribute

Initializes a new instance of the [[fm.liveswitch.sdp.cryptoAttribute]] class.

Parameters:

Name	Type	Description
tag	number	The tag.
cryptoSuite	string	The crypto suite.

Returns: CryptoAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:35

Methods

fmliveswitchsdpCryptoAttributeInit

▸ PrivatefmliveswitchsdpCryptoAttributeInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:31

---

getAttributeType

▸ getAttributeType(): AttributeType

Gets this Attribute's Type.

Returns: AttributeType

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:582

---

getAttributeValue

▸ ProtectedgetAttributeValue(): string

Gets the internal value of the attribute.

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:130

---

getCryptoSuite

▸ getCryptoSuite(): string

Gets the crypto suite. See [[fm.liveswitch.sdp.cryptoAttribute.cryptoSuite]] for possible values.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:156

---

getKey

▸ getKey(): DataBuffer

Gets the key from the "inline" key parameter.

Returns: DataBuffer

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:168

---

getKeyParams

▸ getKeyParams(): Hash<string, string>

Gets the key parameters.

Returns: Hash<string, string>

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:192

---

getMultiplexingCategory

▸ getMultiplexingCategory(): AttributeCategory

Gets the Multiplexing Category of this Attribute.

Returns: AttributeCategory

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:600

---

getSalt

▸ getSalt(): DataBuffer

Gets the salt from the "inline" key parameter.

Returns: DataBuffer

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:204

---

getSessionParams

▸ getSessionParams(): string[]

Gets the session parameters.

Returns: string[]

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:228

---

getTag

▸ getTag(): number

Gets the tag.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:240

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:19

---

setAttributeType

▸ setAttributeType(value: AttributeType): void

Sets this Attribute's Type.

Parameters:

Name	Type
value	AttributeType

Returns: void

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:612

---

setKeySalt

▸ setKeySalt(key: Uint8Array, salt: Uint8Array): CryptoAttribute

Sets the key and salt for the "inline" key parameter.

Parameters:

Name	Type	Description
key	Uint8Array	The key.
salt	Uint8Array	The salt.

Returns: CryptoAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:270

---

setMultiplexingCategory

▸ ProtectedsetMultiplexingCategory(value: AttributeCategory): void

Sets the Multiplexing Category of this Attribute.

Parameters:

Name	Type
value	AttributeCategory

Returns: void

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:624

---

setTag

▸ setTag(value: number): void

Sets the tag.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:299

---

toString

▸ toString(): string

Converts this instance to a string.

Returns: string

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:636

---

createAttribute

▸ StaticcreateAttribute(name: string, value: string): Attribute

Creates an attribute.

Parameters:

Name	Type	Description
name	string	The name.
value	string	The value.

Returns: Attribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:42

---

fromAttributeValue

▸ StaticfromAttributeValue(value: string): CryptoAttribute

Initializes a new instance of the [[fm.liveswitch.sdp.cryptoAttribute]] class.

Parameters:

Name	Type	Description
value	string	The attribute value.

Returns: CryptoAttribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/CryptoAttribute.ts:79

---

getTypeName

▸ StaticgetTypeName(type: Type): string

Gets the name of the attribute type.

Parameters:

Name	Type	Description
type	Type	The attribute type.

Returns: string

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:467

---

isMediaLevel

▸ StaticisMediaLevel(type: Type): boolean

Determines whether the type applies to media streams.

Parameters:

Name	Type	Description
type	Type	The type.

Returns: boolean

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:492

---

isSessionLevel

▸ StaticisSessionLevel(type: Type): boolean

Determines whether the type applies to sessions.

Parameters:

Name	Type	Description
type	Type	The type.

Returns: boolean

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:516

---

parse

▸ Staticparse(s: string): Attribute

Creates an [[fm.liveswitch.sdp.connectionData]] instance from a string.

Parameters:

Name	Type	Description
s	string	The string to parse.

Returns: Attribute

Inherited from: Attribute

Defined in: Generated/TypeScript/fm.liveswitch/sdp/Attribute.ts:540