diff --git a/en/application-dev/media/Readme-EN.md b/en/application-dev/media/Readme-EN.md index 6949606c73c67956d204680c9ccea34764c0df7a..512b228d028b5cde17ffcb0b6d62bce1e65880e1 100755 --- a/en/application-dev/media/Readme-EN.md +++ b/en/application-dev/media/Readme-EN.md @@ -1,10 +1,25 @@ # Media - Audio + - [Audio Overview](audio-overview.md) + - [Audio Playback Development](audio-playback.md) + - [Audio Playback Development Using AudioRenderer](audio-renderer.md) + - [Audio Management Development](audio-management.md) - [Audio Recording Development](audio-recorder.md) + - [Audio Recorder Development Using AudioCapturer](audio-capturer) + +- Video + + - [Video Playback Development](video-playback.md) + + - [Video Recording Development](video-recorder.md) + +- Sound + + - [SoundManager Development](sound-manager.md) diff --git a/en/application-dev/media/audio-recorder.md b/en/application-dev/media/audio-recorder.md index 7d2e040abcc077e9a428b46936dcc36d4d7b2cf5..8468c7e8151733d29175432d8e2427c8b4e19f3b 100644 --- a/en/application-dev/media/audio-recorder.md +++ b/en/application-dev/media/audio-recorder.md @@ -1,264 +1,133 @@ -# Audio Recording Development +# Audio Recording Development -## When to Use +## When to Use -During audio recording, audio signals are recorded and saved. You can set the sampling rate, number of audio channels, bit rate, encoding format, encapsulation format, and file path for audio recording. +During audio recording, audio signals are captured, encoded, and saved to files. You can specify parameters such as the sampling rate, number of audio channels, encoding format, encapsulation format, and file path for audio recording. -## Available APIs +**Figure 1** Audio recording state transition -**Table 1** APIs for audio recording +![en-us_image_audio_recorder_state_machine](figures/en-us_image_audio_recorder_state_machine.png) - - - - - - - - - - - - - - - -

API

-

Description

-

media.createAudioRecorder()

-

Creates an AudioRecorder instance.

-

AudioRecorder

-

Provides audio recording methods.

-

AudioRecorderConfig

-

Provides parameters related to audio recording.

-
-**Table 2** AudioRecorder methods - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Method

-

Description

-

prepare(config: AudioRecorderConfig): void

-

Prepares for audio recording and sets parameters.

-

start(): void

-

Starts audio recording.

-

pause(): void

-

Pauses audio recording. (Not supported yet)

-

resume(): void

-

Resumes audio recording. (Not supported yet)

-

stop(): void

-

Stops audio recording.

-

release(): void

-

Releases audio recording resources.

-

reset(): void

-

Resets audio recording.

-

on('prepare', function callback)

-

Subscribes to the audio recording preparation event.

-

on('start', function callback)

-

Subscribes to the audio recording start event.

-

on('pause', function callback)

-

Subscribes to the audio recording pause event.

-

on('resume', function callback)

-

Subscribes to the audio recording resumption event.

-

on('stop',function callback)

-

Subscribes to the audio recording end event.

-

on('release', function callback)

-

Subscribes to the event of releasing audio recording resources.

-

on('reset', function callback)

-

Subscribes to the audio recording reset event.

-

on('error', function callback)

-

Subscribes to the audio recording error event.

-
+**Figure 2** Layer 0 diagram of audio recording -**Table 3** AudioRecorderConfig +![en-us_image_audio_recorder_zero](figures/en-us_image_audio_recorder_zero.png) - - - - - - - - - - - - - - - - - - - - - - - - -

API

-

Description

-

audioEncoder?: AudioEncoder

-

Audio encoding format. The default value is AAC_LC.

-

audioEncodeBitRate?: number

-

Bit rate for audio encoding. The default value is 48000.

-

audioSampleRate?: number

-

Sampling rate for audio encoding. The default value is 48000.

-

numberOfChannels?: number

-

Number of audio channels. The default value is 2.

-

format?: AudioOutputFormat

-

Audio output format. The default value is MPEG_4.

-

uri: string

-

Audio output path, which starts with file://path or file://fd.

-
+## How to Develop -**Table 4** AudioEncoder +For details about the APIs used for audio recording, see [js-apis-media.md](../reference/apis/js-apis-media.md). - - - - - - - - - -

API

-

Description

-

AAC_LC = 3

-

AAC_LC format.

-
+### Full-Process Scenario -**Table 5** AudioOutputFormat +The full audio recording process includes creating an instance, setting recording parameters, starting, pausing, resuming, and stopping recording, and releasing resources. - - - - - - - - - - - - -

API

-

Description

-

MPEG_4 = 2

-

MPEG-4 format.

-

AAC_ADTS= 6

-

AAC_ADTS format.

-
- -1. Create an audio recorder. - - ``` - import media from '@ohos.multimedia.media'; - var recorder = media.createAudioRecorder(); - ``` - -2. Prepare for audio recording and set parameters. - - ``` - let audioRecorderConfig = { - audioEncoder : AAC_LC , - audioEncodeBitRate : 22050, - audioSampleRate : 22050, - numberOfChannels : 2, - format : AAC_ADTS, - uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a', - } - recorder.prepare(audioRecorderConfig); - ``` - -3. Set the subscription events. - - ``` - recorder.on('prepare', () => { - console.info('setCallback prepare() case callback is called'); - recorder.start(); +```js +function SetCallBack(audioRecorder) { + audioRecorder.on('prepare', () => { // Set the 'prepare' event callback. + console.log('prepare success'); + // The recording page is ready. You can click the Record button to start recording. }); - recorder.on('start', () => { - console.info('setCallback start() case callback is called'); - setTimeout(function(){ - recorder.pause(); - }, 10000); // Pause recording 10 seconds after the recording starts. + audioRecorder.on('start', () => { // Set the 'start' event callback. + console.log('audio recorder start success'); + // The Record button is changed to the pausable state. }); - recorder.on('pause', () => { - console.info('setCallback pause() case callback is called'); - setTimeout(function(){ - recorder.resume(); - }, 10000); // Resume recording 10 seconds after the recording is paused. + audioRecorder.on('pause', () => { // Set the 'pause' event callback. + console.log('audio recorder pause success'); + // The Record button is changed to the recordable state. }); - recorder.on('resume', () => { - console.info('setCallback resume() case callback is called'); - setTimeout(function(){ - recorder.stop(); - }, 10000); // Stop recording 10 seconds after the recording is resumed. + audioRecorder.on('resume', () => { // Set the 'resume' event callback. + console.log('audio recorder resume success'); + // The Record button is changed to the pausable state. }); - recorder.on('stop', () => { - console.info('setCallback stop() case callback is called'); - recorder.release(); + audioRecorder.on('stop', () => { // Set the 'stop' event callback. + console.log('audio recorder stop success'); }); - recorder.on('release', () => { - console.info('setCallback release() case callback is called'); + audioRecorder.on('release', () => { // Set the 'release' event callback. + console.log('audio recorder release success'); }); - recorder.on('error', (err) => { - console.info(`case error called,errCode is ${err.code}`); - console.info(`case error called,errMessage is ${err.message}`); - recorder.reset(); + audioRecorder.on('reset', () => { // Set the 'reset' event callback. + console.log('audio recorder reset success'); + // You need to reset the recording parameters for another recording. }); - ``` - - + audioRecorder.on('error', (error) => { // Set the 'error' event callback. + console.info(`audio error called, errName is ${error.name}`); + console.info(`audio error called, errCode is ${error.code}`); + console.info(`audio error called, errMessage is ${error.message}`); + }); +} + +// 1. Create an AudioRecorder instance. +let audioRecorder = media.createAudioRecorder(); +// 2. Set the callbacks. +SetCallBack(audioRecorder); +// 3. Set the recording parameters. +let audioRecorderConfig = { + audioEncoder : media.AudioEncoder.AAC_LC , + audioEncodeBitRate : 22050, + audioSampleRate : 22050, + numberOfChannels : 2, + format : media.AudioOutputFormat.AAC_ADTS, + uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a', // The file must be created by the caller and granted with proper permissions. + location : { latitude : 30, longitude : 130}, +} +audioRecorder.prepare(audioRecorderConfig); +// 4. Start recording. +audioRecorder.start(); // The start method can be called to trigger the 'start' event callback only after the 'prepare' event callback is complete. +// 5. Pause recording. +audioRecorder.pause(); // The pause method can be called to trigger the 'pause' event callback only after the 'start' event callback is complete. +// 6. Resume recording. +audioRecorder.resume(); // The resume method can be called to trigger the 'resume' event callback only after the 'pause' event callback is complete. +// 7. Stop recording. +audioRecorder.stop(); // The stop method can be called to trigger the 'stop' event callback only after the 'start' or 'resume' event callback is complete. +// 8. Reset recording. +audioRecorder.reset(); // The prepare method can be called for another recording only after the 'reset' event callback is complete. +// 9. Release resources. +audioRecorder.release(); // The AudioRecorder resource is destroyed. +audioRecorder = undefined; +``` + +### Normal Recording Scenario + +Unlike the full-process scenario, the normal recording scenario does not include the process of pausing and resuming recording. + +```js +function SetCallBack(audioPlayer) { + audioRecorder.on('prepare', () => { // Set the 'prepare' event callback. + console.log('prepare success'); + // The recording page is ready. You can click the Record button to start recording. + }); + audioRecorder.on('start', () => { // Set the 'start' event callback. + console.log('audio recorder start success'); + // The Record button is changed to the pausable state. + }); + audioRecorder.on('stop', () => { // Set the 'stop' event callback. + console.log('audio recorder stop success'); + }); + audioRecorder.on('release', () => { // Set the 'release' event callback. + console.log('audio recorder release success'); + }); +} +// 1. Create an AudioRecorder instance. +let audioRecorder = media.createAudioRecorder(); +// 2. Set the callbacks. +SetCallBack(audioRecorder); +// 3. Set the recording parameters. +let audioRecorderConfig = { + audioEncoder : media.AudioEncoder.AAC_LC , + audioEncodeBitRate : 22050, + audioSampleRate : 22050, + numberOfChannels : 2, + format : media.AudioOutputFormat.AAC_ADTS, + uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a', // The file must be created by the caller and granted with proper permissions. + location : { latitude : 30, longitude : 130}, +} +audioRecorder.prepare(audioRecorderConfig) +// 4. Start recording. +audioRecorder.start(); // The start method can be called to trigger the 'start' event callback only after the 'prepare' event callback is complete. +// 5. Stop recording. +audioRecorder.stop(); // The stop method can be called to trigger the 'stop' event callback only after the 'start' or 'resume' event callback is complete. +// 6. Release resources. +audioRecorder.release(); // The AudioRecorder resource is destroyed. +audioRecorder = undefined; +``` diff --git a/en/application-dev/media/video-recorder.md b/en/application-dev/media/video-recorder.md new file mode 100644 index 0000000000000000000000000000000000000000..99de4412e8e33b46b28a8e129e61301da63d6a76 --- /dev/null +++ b/en/application-dev/media/video-recorder.md @@ -0,0 +1,116 @@ +# Video Recording Development + +## When to Use + +During video recording, audio and video signals are captured, encoded, and saved to files. You can specify parameters such as the encoding format, encapsulation format, and file path for video recording. + +**Figure 1** Video recording state transition + +![en-us_image_video_recorder_state_machine](figures/en-us_image_video_recorder_state_machine.png) + + + +**Figure 2** Layer 0 diagram of video recording + +![en-us_image_video_recorder_zero](figures/en-us_image_video_recorder_zero.png) + +## How to Develop + +For details about the APIs used for video recording, see [js-apis-media.md](../reference/apis/js-apis-media.md). + +### Full-Process Scenario + +The full video recording process includes creating an instance, setting recording parameters, recording video, pausing, resuming, and stopping recording, and releasing resources. + +```js +let videoProfile = { + audioBitrate : 48000, + audioChannels : 2, + audioCodec : 'audio/mp4a-latm', + audioSampleRate : 48000, + fileFormat : 'mp4', + videoBitrate : 48000, + videoCodec : 'video/mp4v-es', + videoFrameWidth : 640, + videoFrameHeight : 480, + videoFrameRate : 30 +} + +let videoConfig = { + audioSourceType : 1, + videoSourceType : 0, + profile : videoProfile, + url : 'file:///data/media/01.mp4', + orientationHint : 0, + location : { latitude : 30, longitude : 130 }, +} + +// Error callback triggered in the case of an error +function failureCallback(error) { + console.info('error happened, error name is ' + error.name); + console.info('error happened, error code is ' + error.code); + console.info('error happened, error message is ' + error.message); +} + +// Error callback triggered in the case of an exception +function catchCallback(error) { + console.info('catch error happened, error name is ' + error.name); + console.info('catch error happened, error code is ' + error.code); + console.info('catch error happened, error message is ' + error.message); +} + +let videoRecorder = null; // videoRecorder is an empty object and assigned with a value after createVideoRecorder is successfully called. +let surfaceID = null; // Used to save the surface ID returned by getInputSurface. +// Create a VideoRecorder object. +await media.createVideoRecorder().then((recorder) => { + console.info('case createVideoRecorder called'); + if (typeof (recorder) != 'undefined') { + videoRecorder = recorder; + console.info('createVideoRecorder success'); + } else { + console.info('createVideoRecorder failed'); + } +}, failureCallback).catch(catchCallback); + +// Obtain the surface ID, save it, and pass it to camera-related interfaces. +await videoRecorder.getInputSurface().then((surface) => { + console.info('getInputSurface success'); + surfaceID = surface; +}, failureCallback).catch(catchCallback); + +// Video recording depends on camera-related interfaces. The following operations can be performed only after the video output start interface is invoked. + +// Start video recording. +await videoRecorder.start().then(() => { + console.info('start success'); +}, failureCallback).catch(catchCallback); + +// Pause video playback before the video output stop interface is invoked. +await videoRecorder.pause().then(() => { + console.info('pause success'); +}, failureCallback).catch(catchCallback); + +// Resume video playback after the video output start interface is invoked. +await videoRecorder.resume().then(() => { + console.info('resume success'); +}, failureCallback).catch(catchCallback); + +// Stop video recording after the video output stop interface is invoked. +await videoRecorder.stop().then(() => { + console.info('stop success'); +}, failureCallback).catch(catchCallback); + +// Reset the recording configuration. +await videoRecorder.reset().then(() => { + console.info('reset success'); +}, failureCallback).catch(catchCallback); + +// Release the video recording resources and camera object resources. +await videoRecorder.release().then(() => { + console.info('release success'); +}, failureCallback).catch(catchCallback); + +// Set the related object to null. +videoRecorder = null; +surfaceID = null; +```