Class RTSPToken

An opaque object used for checking authorisations. It is generated after successful authentication.

record

Hierarchy

RTSPToken

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RTSPToken(): RTSPToken

- Defined in GstRtspServer-1.0.d.ts:5426
Create a new empty Authorization token.

Returns RTSPToken

Properties

miniObject

miniObject: Gst.MiniObject

Static name

name: string

Methods

getString

getString(field: string): string

- Defined in GstRtspServer-1.0.d.ts:5381
Get the string value of field in token.

Parameters
- field: string
  
  a field name
Returns string

getStructure

getStructure(): Gst.Structure

- Defined in GstRtspServer-1.0.d.ts:5385
Access the structure of the token.

Returns Gst.Structure

isAllowed

isAllowed(field: string): boolean

- Defined in GstRtspServer-1.0.d.ts:5390
Check if token has a boolean field and if it is set to %TRUE.

Parameters
- field: string
  
  a field name
Returns boolean

setBool

setBool(field: string, boolValue: boolean): void

- Defined in GstRtspServer-1.0.d.ts:5396
Sets a boolean value on token.

Parameters
- field: string
  
  field to set
- boolValue: boolean
  
  boolean value to set
Returns void

setString

setString(field: string, stringValue: string): void

- Defined in GstRtspServer-1.0.d.ts:5402
Sets a string value on token.

Parameters
- field: string
  
  field to set
- stringValue: string
  
  string value to set
Returns void

writableStructure

writableStructure(): Gst.Structure

- Defined in GstRtspServer-1.0.d.ts:5406
Get a writable version of the structure.

Returns Gst.Structure

Static new

new(): RTSPToken

- Defined in GstRtspServer-1.0.d.ts:5431
Create a new empty Authorization token.

Returns RTSPToken