Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • SS

Hierarchy

Implements

Index

Constructors

constructor

Properties

Static Optional ControlsComponent

ControlsComponent: ControlsComponent

Static Optional ErrorComponent

ErrorComponent: ErrorComponent

Static Optional FullscreenComponent

FullscreenComponent: FullscreenComponent | null

Static Optional FullscreenImplementationComponent

FullscreenImplementationComponent: FullscreenImplementationComponent

Static Optional IdleComponent

IdleComponent: IdleComponent

Static Optional LoadingComponent

LoadingComponent: LoadingComponent

Static Optional SeekComponent

SeekComponent: SeekComponent | null

Static Optional StateComponent

StateComponent: StateComponent | null

Static Optional TimeComponent

TimeComponent: TimeComponent | null

Static animate

animate: boolean = false

Static autoPlay

autoPlay: boolean = false

Static Optional implementation

implementation: Implementation

Static lazyLoad

lazyLoad: boolean = false

Static Optional openFullscreen

openFullscreen: OpenFullscreen

Static Optional seekComponentBreakpoint

seekComponentBreakpoint: number | null

Static Optional style

style: TextStyle

Static useDefaultLoadingIndicator

useDefaultLoadingIndicator: boolean = true

Accessors

animate

  • get animate(): boolean

animationDelay

  • get animationDelay(): number

animationDuration

  • get animationDuration(): number

animationEasing

  • get animationEasing(): EasingFunction | undefined

autoPlay

  • get autoPlay(): boolean

buffering

  • get buffering(): boolean

duration

  • get duration(): Milliseconds | undefined

end

  • get end(): Milliseconds

error

  • get error(): Error | undefined

loaded

  • get loaded(): boolean

loading

  • get loading(): boolean

looping

  • get looping(): boolean

paused

  • get paused(): boolean

playing

  • get playing(): boolean

position

  • get position(): Milliseconds | undefined

seekComponentBreakpoint

  • get seekComponentBreakpoint(): number | null | undefined

showLoading

  • get showLoading(): boolean

start

  • get start(): Milliseconds

stopped

  • get stopped(): boolean

tracks

  • get tracks(): ReadonlyArray<ITrackImmutable>

transcript

  • get transcript(): INodeTextImmutable | undefined

transitioning

  • get transitioning(): boolean

type

  • get type(): NodeType.Audio

unloaded

  • get unloaded(): boolean

url

  • get url(): Url

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

  • UNSAFE_componentWillReceiveProps(nextProps: Readonly<IProps>, nextContext: any): void

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): void

catcher

  • catcher(error: Error): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void
  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

componentDidUpdate

  • componentDidUpdate(__namedParameters: object): void
  • Parameters

    • __namedParameters: object
      • prev: undefined | Iterable<IImmutable | IImmutable>

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

  • componentWillReceiveProps(nextProps: Readonly<IProps>, nextContext: any): void

componentWillUnmount

  • componentWillUnmount(): void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IProps>, prevState: Readonly<IState>): SS | null
  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    Returns SS | null

onPressHandler

  • onPressHandler(node: Audio): void | Action | undefined

pause

  • pause(): Promise<void>

play

  • play(): Promise<void>

render

  • render(): React.ReactNode

seek

  • seek(milliseconds: MillisecondsAccepted): Promise<void>

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<IProps>, nextState: Readonly<IState>, nextContext: any): boolean
  • Called to determine whether the change in props and state should trigger a re-render.

    Component always returns true. PureComponent implements a shallow comparison on props and state and returns true if any props or states have changed.

    If false is returned, Component#render, componentWillUpdate and componentDidUpdate will not be called.

    Parameters

    • nextProps: Readonly<IProps>
    • nextState: Readonly<IState>
    • nextContext: any

    Returns boolean

stop

  • stop(): Promise<void>

toggle

  • toggle(): Promise<void>

unload

  • unload(): Promise<void>