Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TimecodePopup<SS>

Renders a small popup window which which the user can add an offset to the timecode or seek the stream. The offset is merely for display convenience, whereas the seek field advances or retracts the current playback position by the given number of seconds. It accepts positive as well as negative values. The position prop indicates the absolute on-screen position the popup will be rendered at. If the prop is not given, nothing will be rendered, effectively hiding the popup.

param

Position the popup should be rendered at

param

Offset for the timecode

param

Callback invoked when the offset is updated

param

Callback invoked when the stream is seeeked

Type parameters

  • SS

Hierarchy

Index

Constructors

constructor

  • Parameters

    Returns TimecodePopup

Properties

context

context: any

props

props: Readonly<object> & Readonly<TimecodePopupProps>

refs

refs: object

Type declaration

  • [key: string]: ReactInstance

Private seekByField

seekByField: Nullable<HTMLInputElement>

state

state: Readonly<__type>

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

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

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<TimecodePopupProps>, nextState: Readonly<__type>, nextContext: any): 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

Optional componentDidMount

  • componentDidMount(): void
  • Called immediately after a compoment is mounted. Setting state here will trigger re-rendering.

    Returns void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<TimecodePopupProps>, prevState: Readonly<__type>, snapshot?: SS): void
  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

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

Optional componentWillUnmount

  • componentWillUnmount(): void
  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<TimecodePopupProps>, nextState: Readonly<__type>, nextContext: any): void

forceUpdate

  • forceUpdate(callBack?: undefined | function): void
  • Parameters

    • Optional callBack: undefined | function

    Returns void

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<TimecodePopupProps>, prevState: Readonly<__type>): 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

render

  • render(): null | Element
  • Renders the component

    Returns null | Element

Private seekBy

  • seekBy(): void
  • Callback invoked when the user hits the button next to the field for seeking the stream. Retrieves the seek value from the ref to the input field and calls the seekBy callback which informs the parent of the new value.

    Returns void

setState

  • setState<K>(state: function | null | S | object, callback?: undefined | function): void
  • Type parameters

    • K: keyof __type

    Parameters

    • state: function | null | S | object
    • Optional callback: undefined | function

    Returns void

Optional shouldComponentUpdate

  • shouldComponentUpdate(nextProps: Readonly<TimecodePopupProps>, nextState: Readonly<__type>, 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

    Returns boolean

Private updateOffset

  • updateOffset(e: ChangeEvent<HTMLInputElement>): void
  • Callback invoked when the user updates the form field for the time offset. Retrieves the new offset value from the passed event and invokes the updateOffset callback which informs the parent of the change.

    Parameters

    • e: ChangeEvent<HTMLInputElement>

      The original change event

    Returns void

Generated using TypeDoc