@video-io/videokit
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Upload

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

Events

Static CANCELED

CANCELED: "canceled" | "stateChanged" | "progress" | "error" = 'canceled'

Triggered when upload is canceled

Static ERROR

ERROR: "canceled" | "stateChanged" | "progress" | "error" = 'error'

Triggered when there is an error with the upload

Static PROGRESS

PROGRESS: "canceled" | "stateChanged" | "progress" | "error" = 'stateChanged'

Triggered when upload progress changes

Static STATE_CHANGED

STATE_CHANGED: "canceled" | "stateChanged" | "progress" | "error" = 'stateChanged'

Triggered when an upload's state changes

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: EventMap & { *: 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: EventMap & { *: 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

Accessors

progress

  • get progress(): number

  • Returns number

state

video

  • get video(): undefined | Video

  • Returns undefined | Video

Methods

cancel

  • cancel(): void

  • Returns void

isActive

  • isActive(): boolean

  • Returns boolean

isCanceled

  • isCanceled(): boolean

  • Returns boolean

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Property
  • Method
  • Inherited property

Generated using TypeDoc