UploadManager | @video-io/videokit

Hierarchy

UploadManager

Index

Properties

Methods

Properties

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: { uploadsChanged: { uploads: Upload[] } } & { *: 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: { uploadsChanged: { uploads: Upload[] } } & { *: 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

uploads

uploads: Upload[]

Methods

cancelAll

cancelAll(): void

Returns void

uploadFile

uploadFile(file: File, videoData: Pick<CreateVideoData, "title" | "metadata" | "tags" | "lat" | "lng" | "shotOn">): Upload

Parameters
- file: File
- videoData: Pick<CreateVideoData, "title" | "metadata" | "tags" | "lat" | "lng" | "shotOn">
Returns Upload

Generated using TypeDoc