Audio
HTMLMediaElementインターフェイスを継承するHTMLAudioElementインターフェイスを実装するReact Nativeコンポーネントです。
拡張
Media<AudioProps,AudioState>
コンストラクタ
new Audio()
new Audio(
props):Audio
パラメーター
props
AudioProps & MediaProps & ViewProps
戻り値
オーバーライド
Media<AudioProps, AudioState>.constructor
プロパティ
context
context:
unknown
新しいスタイルコンテキストを使用する場合は、これをクラス内で再宣言して、静的なcontextTypeのReact.ContextTypeを指すようにします。型注釈またはstatic contextTypeと一緒に使用する必要があります。
例
static contextType = MyContext
// TS 3.7より前の場合:
context!: React.ContextType<typeof MyContext>
// TS 3.7以降の場合:
declare context: React.ContextType<typeof MyContext>
参照
Reactドキュメント(英語のみ)
継承元
Media.context
props
readonlyprops:Readonly<AudioProps&MediaProps&ViewProps>
継承元
Media.props
refs
refs:
object
インデックスシグネチャ
[key: string]: ReactInstance
廃止
参照
レガシーReactドキュメント(英語のみ)
継承元
Media.refs
state
state:
Readonly<AudioState&MediaState>
継承元
Media.state
contextType?
staticoptionalcontextType:Context<any>
設定されている場合、this.contextは実行時に指定コンテキストの現在の値に設定されます。
例
type MyContext = number
const Ctx = React.createContext<MyContext>(0)
class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>マイコンテキストの値:{this.context}</>;
}
}
参照
https://react.dev/reference/react/Component#static-contexttype
継承元
Media.contextType
メソッド
componentDidCatch()?
optionalcomponentDidCatch(error,errorInfo):void
子孫コンポーネントで生成された例外をキャッチします。未処理の例外が発生すると、コンポーネントツリー全体がマウント解除されます。
パラメーター
error
Error
errorInfo
ErrorInfo
戻り値
void
継承元
Media.componentDidCatch
componentWillMount()?
optionalcomponentWillMount():void
マウントが発生する直前およびComponent.renderの前に呼び出されます。このメソッド内で副作用やサブスクリプションを導入することは避けてください。
注:NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate、またはStaticLifecycle.getDerivedStateFromProps getDerivedStateFromPropsが存在すると、これが呼び出されません。
戻り値
void
廃止
16.3では、代わりにComponentLifecycle.componentDidMount componentDidMount、またはコンストラクタを使用してください。React 17では動作しなくなります
参照
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
継承元
Media.componentWillMount
componentWillReceiveProps()?
optionalcomponentWillReceiveProps(nextProps,nextContext):void
コンポーネントが新しいプロパティを受け取る可能性があるときに呼び出されます。プロパティが変更されていなくてもReactから呼び出されることがあるため、変更のみを処理する場合は、必ず新しいプロパティと既存のプロパティを比較してください。
通常、Component.setStateを呼び出しても、このメソッドはトリガーされません。
注:NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate、またはStaticLifecycle.getDerivedStateFromProps getDerivedStateFromPropsが存在すると、これが呼び出されません。
パラメーター
nextProps
Readonly<AudioProps & MediaProps & ViewProps>
nextContext
any
戻り値
void
廃止
16.3では、代わりにStaticLifecycle.getDerivedStateFromProps getDerivedStateFromPropsを使用してください。React 17では動作しなくなります
参照
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
継承元
Media.componentWillReceiveProps
componentWillUpdate()?
optionalcomponentWillUpdate(nextProps,nextState,nextContext):void
新しいプロパティまたは状態を受け取ったときに、レンダリングの直前に呼び出されます。初回のレンダリングでは呼び出されません。
注: ここでComponent.setStateを呼び出すことはできません。
注:NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate、またはStaticLifecycle.getDerivedStateFromProps getDerivedStateFromPropsが存在すると、これが呼び出されません。
パラメーター
nextProps
Readonly<AudioProps & MediaProps & ViewProps>
nextState
Readonly<AudioState & MediaState>
nextContext
any
戻り値
void
廃止
16.3、代わりにgetSnapshotBeforeUpdateを使用してください。React 17では動作しなくなります。
参照
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
継承元
Media.componentWillUpdate
destroyMediaPlayerSync()
destroyMediaPlayerSync(
timeoutInMs):MediaPlayerDeInitStatus
パラメーター
timeoutInMs
number
クライアントが設定したタイムアウトしきい値
戻り値
MediaPlayerDeInitStatus
MediaPlayerDeInitStatus
概要
プレーヤーを同期的に初期化解除します
オーバーライド
Media.destroyMediaPlayerSync
forceUpdate()
forceUpdate(
callback?):void
パラメーター
callback?
() => void
戻り値
void
継承元
Media.forceUpdate
getSnapshotBeforeUpdate()?
optionalgetSnapshotBeforeUpdate(prevProps,prevState):any
ReactがComponent.renderのレンダリングの結果をドキュメントに適用する前に実行され、componentDidUpdateに渡されるオブジェクトを返します。Component.renderレンダリングによって変更が加えられる前に、スクロール位置などの情報を保存するために役立ちます。
注:このメソッドが存在すると、非推奨のライフサイクルイベントは実行されません。
パラメーター
prevProps
Readonly<AudioProps & MediaProps & ViewProps>
prevState
Readonly<AudioState & MediaState>
戻り値
any
継承元
Media.getSnapshotBeforeUpdate
setState()
setState<
K>(state,callback?):void
型パラメーター
• K extends never
パラメーター
state
AudioState & MediaState |
(prevState, props) => AudioState & MediaState | Pick<AudioState & MediaState, K> |
Pick<AudioState & MediaState, K> |
callback?
() => void
戻り値
void
継承元
Media.setState
shouldComponentUpdate()?
optionalshouldComponentUpdate(nextProps,nextState,nextContext):boolean
プロパティと状態の変更の結果、再レンダリングをトリガーする必要があるかどうかを決定するために呼び出されます。
Componentは常にtrueを返します。PureComponentはプロパティと状態の浅い比較を実装し、いずれかのプロパティまたは状態が変更されている場合にtrueを返します。
falseが返された場合、Component.render、componentWillUpdate、componentDidUpdateは呼び出されません。
パラメーター
nextProps
Readonly<AudioProps & MediaProps & ViewProps>
nextState
Readonly<AudioState & MediaState>
nextContext
any
戻り値
boolean
継承元
Media.shouldComponentUpdate
UNSAFE_componentWillMount()?
optionalUNSAFE_componentWillMount():void
マウントが発生する直前およびComponent.renderの前に呼び出されます。このメソッド内で副作用やサブスクリプションを導入することは避けてください。
このメソッドはReact 17でも動作します。
注:NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate、またはStaticLifecycle.getDerivedStateFromProps getDerivedStateFromPropsが存在すると、これが呼び出されません。
戻り値
void
廃止
16.3では、代わりにComponentLifecycle.componentDidMount componentDidMount、またはコンストラクタを使用してください。
参照
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
継承元
Media.UNSAFE_componentWillMount
UNSAFE_componentWillReceiveProps()?
optionalUNSAFE_componentWillReceiveProps(nextProps,nextContext):void
コンポーネントが新しいプロパティを受け取る可能性があるときに呼び出されます。プロパティが変更されていなくてもReactから呼び出されることがあるため、変更のみを処理する場合は、必ず新しいプロパティと既存のプロパティを比較してください。
通常、Component.setStateを呼び出しても、このメソッドはトリガーされません。
このメソッドはReact 17でも動作します。
注:NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate、またはStaticLifecycle.getDerivedStateFromProps getDerivedStateFromPropsが存在すると、これが呼び出されません。
パラメーター
nextProps
Readonly<AudioProps & MediaProps & ViewProps>
nextContext
any
戻り値
void
廃止
16.3では、代わりにStaticLifecycle.getDerivedStateFromProps getDerivedStateFromPropsを使用してください。
参照
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
継承元
Media.UNSAFE_componentWillReceiveProps
UNSAFE_componentWillUpdate()?
optionalUNSAFE_componentWillUpdate(nextProps,nextState,nextContext):void
新しいプロパティまたは状態を受け取ったときに、レンダリングの直前に呼び出されます。初回のレンダリングでは呼び出されません。
注: ここでComponent.setStateを呼び出すことはできません。
このメソッドはReact 17でも動作します。
注:NewLifecycle.getSnapshotBeforeUpdate getSnapshotBeforeUpdate、またはStaticLifecycle.getDerivedStateFromProps getDerivedStateFromPropsが存在すると、これが呼び出されません。
パラメーター
nextProps
Readonly<AudioProps & MediaProps & ViewProps>
nextState
Readonly<AudioState & MediaState>
nextContext
any
戻り値
void
廃止
16.3、代わりにgetSnapshotBeforeUpdateを使用してください。
参照
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update
- https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path
継承元
Media.UNSAFE_componentWillUpdate
Last updated: 2025年10月2日

