Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional ControlsComponent

ControlsComponent: ControlsComponent | null

A custom controls component

Optional FullscreenComponent

FullscreenComponent: FullscreenComponent | null

Overrides the fullscreen opening component, usually a fullscreen icon

Optional FullscreenImplementationComponent

FullscreenImplementationComponent: FullscreenImplementationComponent | null

Overrides the fullscreen implementation component

Optional ImplementationComponent

ImplementationComponent: ImplementationComponent

Overrides the image rendering implementation for this instance

Optional SeekComponent

SeekComponent: SeekComponent | null

Overrides the seekin component, usually a seekable bar

Optional StateComponent

StateComponent: StateComponent | null

Overrides the control of the state component, usually a play/pause button

Optional TimeComponent

TimeComponent: TimeComponent | null

Overrides the time display seek component, usually a text based position/duration component

Optional animate

animate: undefined | false | true

Determines if the components should animate the controls

Optional animationDelay

animationDelay: undefined | number

How long to delay the animations

Optional animationDuration

animationDuration: undefined | number

How long the animations should take

Optional animationEasing

animationEasing: EasingFunction

The easing to use for the animation

aspect

aspect: number

Must provide the aspect ratio of the video

Optional autoPlay

autoPlay: undefined | false | true

The video should automatically play when loaded

Optional controls

controls: undefined | false | true

Determines if the controls should be shown

Optional controlsDuration

controlsDuration: MillisecondsAccepted

The length of time the controls should be shown for before fading

Optional disableFocus

disableFocus: undefined | false | true

Prevent the video from requesting audio focus

Optional end

end: MillisecondsAccepted

Optional gifify

gifify: undefined | false | true

Turns the component into a GIF type video, i.e. it autoplays, has no controls, doesn't grab audio focus.

Optional localized

localized: undefined | false | true

Optional loop

loop: undefined | false | true

Determines if the video should loop

Optional openFullscreen

openFullscreen: OpenFullscreen

Overrides the fullscreen implementation for this instance

position

position: Milliseconds | undefined

The starting position of the video

Optional positionInterval

positionInterval: MillisecondsAccepted

If supported by the implementation, the position will only be updated on this interval

Optional seekComponentBreakpoint

seekComponentBreakpoint: number | null

The seek component is a variable width component and needs a certain amount of space to be useful. The audio component will only render the seek component when there is enough space to make the user experience sensible. This is often around 100 pixels.

Set this property to override that break width. Setting it to null will result in the flex being removed entirely and the component being rendered at it's full width.

Optional start

start: MillisecondsAccepted

Optional theme

theme: ITheme

Optional tracks

tracks: Iterable<ITrackImmutable>

url

url: UrlAccepted

Methods

close

  • close(position: Milliseconds | undefined, state: State | undefined): void

Optional onLoad

  • onLoad(): void

Optional onPosition

  • onPosition(position: Milliseconds): void

Optional onStateChange

  • onStateChange(state: State): void