Types

NOTE

The initial APIs of this module are supported since API version 6. Newly added APIs will be marked with a superscript to indicate their earliest API version.

SoundPool¹⁰⁺

type SoundPool = _SoundPool

SoundPool, which provides APIs for loading, unloading, playing, and stopping playing system sounds, setting the volume, and setting the number of loops.

System capability: SystemCapability.Multimedia.Media.SoundPool

Type	Description
_SoundPool	Provides APIs for loading, unloading, playing, and stopping playing system sounds, setting the volume, and setting the number of loops.

PlayParameters¹⁰⁺

type PlayParameters = _PlayParameters

Describes the playback parameters of the sound pool.

System capability: SystemCapability.Multimedia.Media.SoundPool

Type	Description
_PlayParameters	Playback parameters of the sound pool.

AVPlayerState⁹⁺

type AVPlayerState = 'idle'|'initialized'|'prepared'|'playing'|'paused'|'completed'|'stopped'|'released'|'error'

Describes the state of the AVPlayer. Your application can proactively obtain the AVPlayer state through the state property or obtain the reported AVPlayer state by subscribing to the stateChange event. For details about the rules for state transition, see Audio Playback.

Atomic service API: This API can be used in atomic services since API version 11.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Type	Description
'idle'	The AVPlayer enters this state after createAVPlayer() or reset() is called. In case createAVPlayer() is used, all properties are set to their default values. In case reset() is called, the url9+, fdSrc9+, or dataSrc10+ property and the loop property are reset, and other properties are retained.
'initialized'	The AVPlayer enters this state after url9+ or fdSrc9+ property is set in the idle state. In this case, you can configure static properties such as the window and audio.
'prepared'	The AVPlayer enters this state when prepare() is called in the initialized state. In this case, the playback engine has prepared the resources.
'playing'	The AVPlayer enters this state when play() is called in the prepared, paused, or completed state.
'paused'	The AVPlayer enters this state when pause() is called in the playing state.
'completed'	The AVPlayer enters this state when a media asset finishes playing and loop playback is not set (no loop = true). In this case, if play() is called, the AVPlayer enters the playing state and replays the media asset; if stop() is called, the AVPlayer enters the stopped state.
'stopped'	The AVPlayer enters this state when stop() is called in the prepared, playing, paused, or completed state. In this case, the playback engine retains the properties but releases the memory resources. You can call prepare() to prepare the resources again, call reset() to reset the properties, or call release() to destroy the playback engine.
'released'	The AVPlayer enters this state when release() is called. The playback engine associated with the AVPlayer instance is destroyed, and the playback process ends. This is the final state.
'error'	The AVPlayer enters this state when an irreversible error occurs in the playback engine. You can call reset() to reset the properties or call release() to destroy the playback engine. For details about the error codes, see Media Error Codes. NOTE Distinguishing the error state from the on('error') state: 1. When the AVPlayer enters the error state, the on('error') event is triggered. You can obtain the detailed error information through this event. 2. When the AVPlayer enters the error state, the playback service stops. This requires the client to design a fault tolerance mechanism to call reset() or release(). 3. The client receives on('error') event but the AVPlayer does not enter the error state. This situation occurs due to either of the following reasons: Cause 1: The client calls an API in an incorrect state or passes in an incorrect parameter, and the AVPlayer intercepts the call. If this is the case, the client must correct its code logic. Cause 2: A stream error is detected during playback. As a result, the container and decoding are abnormal for a short period of time, but continuous playback and playback control operations are not affected. If this is the case, the client does not need to design a fault tolerance mechanism.

OnTrackChangeHandler¹²⁺

type OnTrackChangeHandler = (index: number, isSelected: boolean) => void

Describes the callback invoked for the track change event.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Name	Type	Mandatory	Description
index	number	Yes	Index of the track that has changed.
isSelected	boolean	Yes	Whether the track at the current index is selected. true if selected, false otherwise.

OnAVPlayerStateChangeHandle¹²⁺

type OnAVPlayerStateChangeHandle = (state: AVPlayerState, reason: StateChangeReason) => void

Describes the callback invoked for the AVPlayer state change event.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Name	Type	Mandatory	Description
state	AVPlayerState	Yes	State of the AVPlayer.
reason	StateChangeReason	Yes	Reason for the state change.

OnBufferingUpdateHandler¹²⁺

type OnBufferingUpdateHandler = (infoType: BufferingInfoType, value: number) => void

Describes the callback invoked for the buffering update event.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Name	Type	Mandatory	Description
infoType	BufferingInfoType	Yes	Buffering information type.
value	number	Yes	Value of the buffering information type.

OnVideoSizeChangeHandler¹²⁺

type OnVideoSizeChangeHandler = (width: number, height: number) => void

Describes the callback invoked for the video size change event.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Name	Type	Mandatory	Description
width	number	Yes	Video width, in px.
height	number	Yes	Video height, in px.

OnSuperResolutionChanged ¹⁸⁺

type OnSuperResolutionChanged = (enabled: boolean) => void

Describes the callback used to listen for video super resolution status changes. If super resolution is enabled by using PlaybackStrategy, this callback is invoked to report the super resolution status changes. It is also invoked to report the initial status when the video starts. However, this callback is not invoked when super resolution is not enabled.

Super resolution is automatically disabled in either of the following cases:

• The current super resolution algorithm only works with videos that have a frame rate of 30 fps or lower. If the video frame rate exceeds 30 fps, or if the input frame rate exceeds the processing capability of the super resolution algorithm in scenarios such as fast playback, super resolution is automatically disabled.
• The current super resolution algorithm supports input resolutions from 320 × 320 to 1920 × 1080, in px. If the input video resolution exceeds the range during playback, super resolution is automatically disabled.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Name	Type	Mandatory	Description
enabled	boolean	Yes	Whether super resolution is enabled. true if enabled, false otherwise.

OnSeiMessageHandle¹⁸⁺

type OnSeiMessageHandle = (messages: Array<SeiMessage>, playbackPosition?: number) => void

Describes the handle used to obtain SEI messages. This is used when in subscriptions to SEI message events, and the callback returns detailed SEI information.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Name	Type	Mandatory	Description
messages	Array<SeiMessage>	Yes	Array of SEI messages.
playbackPosition	number	No	Current playback position, in milliseconds.

OnPlaybackRateDone²⁰⁺

type OnPlaybackRateDone = (rate: number) => void

Describes the callback invoked for the event indicating that the playback rate setting is complete.

Atomic service API: This API can be used in atomic services since API version 20.

System capability: SystemCapability.Multimedia.Media.AVPlayer

Parameters

Name	Type	Mandatory	Description
rate	number	Yes	Playback rate.

OnFrameFetched²³⁺

type OnFrameFetched = (frameInfo: FrameInfo, err?: BusinessError<void>) => void

Describes the callback invoked when thumbnails are obtained in batches.

Model constraint: This API can be used only in the stage model.

System capability: SystemCapability.Multimedia.Media.AVMetadataExtractor

Parameters

Name	Type	Mandatory	Description
frameInfo	FrameInfo	Yes	Thumbnail information.
err	BusinessError<void>	No	Error that occurs when the thumbnail is obtained. The default value is null.

AVRecorderState⁹⁺

type AVRecorderState = 'idle'|'prepared'|'started'|'paused'|'stopped'|'released'|'error'

Enumerates the AVRecorder states. You can obtain the state through the state property.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Type	Description
'idle'	The AVRecorder enters this state after it is just created or the AVRecorder.reset() API is called when the AVRecorder is in any state except released. In this state, you can call AVRecorder.prepare() to set recording parameters. The AVRecorder enters this state after it is just created or the AVRecorder.reset() API is called when the AVRecorder is in any state except released.
'prepared'	The AVRecorder enters this state when the parameters are set. In this state, you can call AVRecorder.start() to start recording.
'started'	The AVRecorder enters this state when the recording starts. In this state, you can call AVRecorder.pause() to pause recording or call AVRecorder.stop() to stop recording.
'paused'	The AVRecorder enters this state when the recording is paused. In this state, you can call AVRecorder.resume() to continue recording or call AVRecorder.stop() to stop recording.
'stopped'	The AVRecorder enters this state when the recording stops. In this state, you can call AVRecorder.prepare() to set recording parameters so that the AVRecorder enters the prepared state again.
'released'	The AVRecorder enters this state when the recording resources are released. In this state, no operation can be performed. In any other state, you can call AVRecorder.release() to enter the released state.
'error'	The AVRecorder enters this state when an irreversible error occurs in the AVRecorder instance. In this state, the AVRecorder.on('error') event is reported, with the detailed error cause. In the error state, you must call AVRecorder.reset() to reset the AVRecorder instance or call AVRecorder.release() to release the resources.

OnAVRecorderStateChangeHandler¹²⁺

type OnAVRecorderStateChangeHandler = (state: AVRecorderState, reason: StateChangeReason) => void

Describes the callback invoked for the AVRecorder state change event.

Atomic service API: This API can be used in atomic services since API version 12.

System capability: SystemCapability.Multimedia.Media.AVRecorder

Parameters

Name	Type	Mandatory	Description
state	AVRecorderState	Yes	AVRecorder state.
reason	StateChangeReason	Yes	Reason for the state change.

SourceOpenCallback¹⁸⁺

type SourceOpenCallback = (request: MediaSourceLoadingRequest) => number

This callback function is implemented by applications to handle resource open requests and return a unique handle for the opened resource.

NOTE

The client must return the handle immediately after processing the request.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.Multimedia.Media.Core

Parameters

Name	Type	Mandatory	Description
request	MediaSourceLoadingRequest	Yes	Parameters for the resource open request, including detailed information about the requested resource and the data push method.

Return value

Type	Description
number	Handle for the current resource open request. A value greater than 0 means the request is successful, whereas a value less than or equal to 0 means it fails. - The handle for the request object is unique.

Example

import { HashMap } from '@kit.ArkTS';
import { media } from '@kit.MediaKit';

let uuid: number = 1;
let requests: HashMap<number, media.MediaSourceLoadingRequest> = new HashMap();

let sourceOpenCallback: media.SourceOpenCallback = (request: media.MediaSourceLoadingRequest) => {
  console.info(`Opening resource: ${request.url}`);
  // Open the resource and return a unique handle, ensuring the mapping between the UUID and request.
  uuid += 1;
  requests.set(uuid, request);
  return uuid;
};

SourceReadCallback¹⁸⁺

type SourceReadCallback = (uuid: number, requestedOffset: number, requestedLength: number) => void

This callback function is implemented by applications to handle resource read requests. When data is available, applications should push it to the player using the respondData API of the corresponding MediaSourceLoadingRequest object.

NOTE

The client must return the handle immediately after processing the request.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.Multimedia.Media.Core

Parameters

Name	Type	Mandatory	Description
uuid	number	Yes	ID for the resource handle.
requestedOffset	number	Yes	Offset of the current media data relative to the start of the resource.
requestedLength	number	Yes	Length of the current request. The value -1 indicates reaching the end of the resource. After pushing the data, call finishLoading to notify the player that the push is complete.

Example

let sourceReadCallback: media.SourceReadCallback = (uuid: number, requestedOffset: number, requestedLength: number) => {
  console.info(`Reading resource with handle ${uuid}, offset: ${requestedOffset}, length: ${requestedLength}`);
  // Check whether the UUID is valid and store the read request. Avoid blocking the request while pushing data and header information.
};

SourceCloseCallback¹⁸⁺

type SourceCloseCallback = (uuid: number) => void

This callback function is implemented by applications to release related resources.

NOTE

The client must return the handle immediately after processing the request.

Atomic service API: This API can be used in atomic services since API version 18.

System capability: SystemCapability.Multimedia.Media.Core

Parameters

Name	Type	Mandatory	Description
uuid	number	Yes	ID for the resource handle.

Example

import { HashMap } from '@kit.ArkTS';

let requests: HashMap<number, media.MediaSourceLoadingRequest> = new HashMap();

let sourceCloseCallback: media.SourceCloseCallback = (uuid: number) => {
  console.info(`Closing resource with handle ${uuid}`);
  // Clear resources related to the current UUID.
  requests.remove(uuid);
};

PlaybackMetrics²³⁺

type PlaybackMetrics = Record<PlaybackMetricsKey, Object>

Describes the container for the key-value pairs of playback metrics.

System capability: SystemCapability.Multimedia.Media.Core

Type	Description
Record<PlaybackMetricsKey, Object>	Playback metrics. The value type is key-value pair. For details about the types and ranges of keys and values, see PlaybackMetricsKey.

AudioState^(deprecated)

type AudioState = 'idle'|'playing'|'paused'|'stopped'|'error'

Describes the audio playback state. You can obtain the state through the state property.

NOTE This API is supported since API version 6 and deprecated since API version 9. You are advised to use AVPlayerState instead.

System capability: SystemCapability.Multimedia.Media.AudioPlayer

Type	Description
'idle'	No audio playback is in progress. The audio player is in this state after the 'dataload' or 'reset' event is triggered.
'playing'	Audio playback is in progress. The audio player is in this state after the 'play' event is triggered.
'paused'	Audio playback is paused. The audio player is in this state after the 'pause' event is triggered.
'stopped'	Audio playback is stopped. The audio player is in this state after the 'stop' event is triggered.
'error'	Audio playback is in the error state.

VideoPlayState^(deprecated)

type VideoPlayState = 'idle'|'prepared'|'playing'|'paused'|'stopped'|'error'

Describes the video playback state. You can obtain the state through the state property.

NOTE This API is supported since API version 8 and deprecated since API version 9. You are advised to use AVPlayerState instead.

System capability: SystemCapability.Multimedia.Media.VideoPlayer

Type	Description
'idle'	The video player is idle.
'prepared'	Video playback is being prepared.
'playing'	Video playback is in progress.
'paused'	Video playback is paused.
'stopped'	Video playback is stopped.
'error'	Video playback is in the error state.

你可能感兴趣的鸿蒙文章

openharmony 鸿蒙 capi-avrecorder-oh-avrecorder-range

openharmony 鸿蒙 errorcode-media

openharmony 鸿蒙 capi-avplayer

openharmony 鸿蒙 capi-avplayer-base-h

openharmony 鸿蒙 capi-avimage-generator-h

openharmony 鸿蒙 capi-avscreencapture-oh-rect

openharmony 鸿蒙 capi-videoprocessing-videoprocessing-callback

openharmony 鸿蒙 capi-avsinkbase

openharmony 鸿蒙 capi-avmetadataextractor

openharmony 鸿蒙 capi-avscreencapture-oh-multidisplaycapability