Audio - Amazon Vega Docs

A react native component that Implements the HTMLAudioElement interface that extends HTMLMediaElement interface..

Extends

Media<AudioProps, AudioState>

Constructors

new Audio()

new Audio(props): Audio

Parameters

props

AudioProps & MediaProps & ViewProps

Returns

Audio

Overrides

Properties

context

context: unknown If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

Example

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>

See

React Docs

Inherited from

Media.context

props

readonly props: Readonly<AudioProps & MediaProps & ViewProps>

Inherited from

Media.props

refs

refs: object

Index Signature

Deprecated

See

Legacy React Docs

Inherited from

Media.refs

state

state: Readonly<AudioState & MediaState>

Inherited from

Media.state

contextType?

static optional contextType: Context<any> If set, this.context will be set at runtime to the current value of the given Context.

Example

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
  static contextType = Ctx
  context!: React.ContextType<typeof Ctx>
  render () {
    return <>My context's value: {this.context}</>;
  }
}

See

https://react.dev/reference/react/Component#static-contexttype

Inherited from

Media.contextType

Methods

componentDidCatch()?

optional componentDidCatch(error, 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

Inherited from

Media.componentDidCatch

componentWillMount()?

optional componentWillMount(): void Called immediately before mounting occurs, and before Component.render. Avoid introducing any side-effects or subscriptions in this method. Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Returns

void

Deprecated

16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead; will stop working in React 17

See

Inherited from

Media.componentWillMount

componentWillReceiveProps()?

optional componentWillReceiveProps(nextProps, nextContext): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component.setState generally does not trigger this method. Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters

nextProps

Readonly<AudioProps & MediaProps & ViewProps>

nextContext

any

Returns

void

Deprecated

16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead; will stop working in React 17

See

Inherited from

Media.componentWillReceiveProps

componentWillUpdate()?

optional componentWillUpdate(nextProps, nextState, nextContext): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component.setState here. Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters

nextProps

Readonly<AudioProps & MediaProps & ViewProps>

nextState

Readonly<AudioState & MediaState>

nextContext

any

Returns

void

Deprecated

16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17

See

Inherited from

Media.componentWillUpdate

destroyMediaPlayerSync()

destroyMediaPlayerSync(timeoutInMs): MediaPlayerDeInitStatus

Parameters

timeoutInMs

number timeout threshold set by client

Returns

MediaPlayerDeInitStatus MediaPlayerDeInitStatus

Brief

DeInitiailzes the player synchronously

Overrides

Media.destroyMediaPlayerSync

forceUpdate()

forceUpdate(callback?): void

Parameters

callback?

() => void

Returns

void

Inherited from

Media.forceUpdate

getSnapshotBeforeUpdate()?

optional getSnapshotBeforeUpdate(prevProps, prevState): any Runs before React applies the result of Component.render render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before Component.render render causes changes to it. Note: the presence of this method prevents any of the deprecated lifecycle events from running.

Parameters

prevProps

Readonly<AudioProps & MediaProps & ViewProps>

prevState

Readonly<AudioState & MediaState>

Returns

any

Inherited from

Media.getSnapshotBeforeUpdate

setState()

setState<K>(state, callback?): void

Type Parameters

• K extends never

Parameters

state

`AudioState` & `MediaState`	(`prevState`, `props`) => `AudioState` & `MediaState` \| `Pick`<`AudioState` & `MediaState`, `K`>	`Pick`<`AudioState` & `MediaState`, `K`>

callback?

() => void

Returns

void

Inherited from

Media.setState

shouldComponentUpdate()?

optional shouldComponentUpdate(nextProps, nextState, nextContext): 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<AudioProps & MediaProps & ViewProps>

nextState

Readonly<AudioState & MediaState>

nextContext

any

Returns

boolean

Inherited from

Media.shouldComponentUpdate

UNSAFE_componentWillMount()?

optional UNSAFE_componentWillMount(): void Called immediately before mounting occurs, and before Component.render. Avoid introducing any side-effects or subscriptions in this method. This method will not stop working in React 17. Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Returns

void

Deprecated

16.3, use ComponentLifecycle.componentDidMount componentDidMount or the constructor instead

See

Inherited from

Media.UNSAFE_componentWillMount

UNSAFE_componentWillReceiveProps()?

optional UNSAFE_componentWillReceiveProps(nextProps, nextContext): void Called when the component may be receiving new props. React may call this even if props have not changed, so be sure to compare new and existing props if you only want to handle changes. Calling Component.setState generally does not trigger this method. This method will not stop working in React 17. Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters

nextProps

Readonly<AudioProps & MediaProps & ViewProps>

nextContext

any

Returns

void

Deprecated

16.3, use static StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps instead

See

Inherited from

Media.UNSAFE_componentWillReceiveProps

UNSAFE_componentWillUpdate()?

optional UNSAFE_componentWillUpdate(nextProps, nextState, nextContext): void Called immediately before rendering when new props or state is received. Not called for the initial render. Note: You cannot call Component.setState here. This method will not stop working in React 17. Note: the presence of NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate or StaticLifecycle.getDerivedStateFromProps getDerivedStateFromProps prevents this from being invoked.

Parameters

nextProps

Readonly<AudioProps & MediaProps & ViewProps>

nextState

Readonly<AudioState & MediaState>

nextContext

any

Returns

void

Deprecated

16.3, use getSnapshotBeforeUpdate instead

See

Inherited from

Media.UNSAFE_componentWillUpdate

​Extends

​Constructors

​new Audio()

​Parameters

props

​Returns

​Overrides

​Properties

​context

​Example

​See

​Inherited from

​props

​Inherited from

​refs

​Index Signature

​Deprecated

​See

​Inherited from

​state

​Inherited from

​contextType?

​Example

​See

​Inherited from

​Methods

​componentDidCatch()?

​Parameters

error

errorInfo

​Returns

​Inherited from

​componentWillMount()?

​Returns

​Deprecated

​See

​Inherited from

​componentWillReceiveProps()?

​Parameters

nextProps

nextContext

​Returns

​Deprecated

​See

​Inherited from

​componentWillUpdate()?

​Parameters

nextProps

nextState

nextContext

​Returns

​Deprecated

​See

​Inherited from

​destroyMediaPlayerSync()

​Parameters

timeoutInMs

​Returns

​Brief

​Overrides

​forceUpdate()

​Parameters

callback?

​Returns

​Inherited from

​getSnapshotBeforeUpdate()?

​Parameters

prevProps

prevState

​Returns

​Inherited from

​setState()

​Type Parameters

​Parameters

state

callback?

​Returns

​Inherited from

​shouldComponentUpdate()?

​Parameters

Extends

Constructors

new Audio()

Parameters

Returns

Overrides

Properties

context

Example

See

Inherited from

props

Inherited from

refs

Index Signature

Deprecated

See

Inherited from

state

Inherited from

contextType?

Example

See

Inherited from

Methods

componentDidCatch()?

Parameters

Returns

Inherited from

componentWillMount()?

Returns

Deprecated

See

Inherited from

componentWillReceiveProps()?

Parameters

Returns

Deprecated

See

Inherited from

componentWillUpdate()?

Parameters

Returns

Deprecated

See

Inherited from

destroyMediaPlayerSync()

Parameters

Returns

Brief

Overrides

forceUpdate()

Parameters

Returns

Inherited from

getSnapshotBeforeUpdate()?

Parameters

Returns

Inherited from

setState()

Type Parameters

Parameters

Returns

Inherited from

shouldComponentUpdate()?

Parameters

Returns

Inherited from

UNSAFE_componentWillMount()?

Returns

Deprecated

See

Inherited from

UNSAFE_componentWillReceiveProps()?

Parameters

Returns

Deprecated

See

Inherited from

UNSAFE_componentWillUpdate()?