SessionManager | @video-io/videokit

Hierarchy

SessionManager

Index

Properties

Properties

Optional appToken

appToken: string

Optional identity

identity: string

Optional sessionToken

sessionToken: string

startSession

startSession: (params: SessionParams, callback?: AsyncCallback<SessionState>) => Promise<SessionState>

Type declaration

- (params: SessionParams, callback?: AsyncCallback<SessionState>): Promise<SessionState>
- Parameters
  - params: SessionParams
  - Optional callback: AsyncCallback<SessionState>
  Returns Promise<SessionState>

state

state: SessionState

stopSession

stopSession: () => void

Type declaration

- (): void
- Returns void

subscribe

subscribe: <FullEventMap, Event>(event: Event, callback: EventHandler<Event, FullEventMap[Event]>) => () => void

Type declaration

- <FullEventMap, Event>(event: Event, callback: EventHandler<Event, FullEventMap[Event]>): () => void
- Subscribe on event
  
  Type parameters
  - FullEventMap: { stateChanged: { state: SessionState } } & { *: any }
  - Event: string
  Parameters
  - event: Event
    
    This string can contain: event name, namespace of event name, list of event names separated by a space or '*' to subscribe on all events
  - callback: EventHandler<Event, FullEventMap[Event]>
    
    Callback function
  Returns () => void
  - Function that cancels current subscription
  - - (): void
    - Returns void

unsubscribe

unsubscribe: <FullEventMap, Event>(event: Event, callback?: EventHandler<Event, FullEventMap[Event]>) => void

Type declaration

- <FullEventMap, Event>(event: Event, callback?: EventHandler<Event, FullEventMap[Event]>): void
- Unsubscribe from event
  
  Type parameters
  - FullEventMap: { stateChanged: { state: SessionState } } & { *: any }
  - Event: string
  Parameters
  - event: Event
    
    This string can contain: event name, namespace of event name, list of event names separated by a space or '*' to unsubscribe from all events
  - Optional callback: EventHandler<Event, FullEventMap[Event]>
    
    Callback function
  Returns void

Generated using TypeDoc