1 Star 0 Fork 5.1K

youguilin / docs

forked from OpenHarmony / docs 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
audio-playback.md 25.31 KB
一键复制 编辑 原始数据 按行查看 历史
NEEN 提交于 2021-06-02 22:39 . !333 update docs bugs

Audio Playback

NOTE: Due to permission issues, these feature are temporarily unavailable for the standard system.

Modules to Import

import audio from '@ohos.multimedia.media';

Required Permissions

None

Methods

createAudioPlayer()

Creates an AudioPlayer instance to control audio playback.

Return Values

Type

Description

AudioPlayer

Returns the AudioPlayer instance if the operation is successful; returns null otherwise.

Example

var audioplayer = audio.createAudioPlayer(); 

Appendixes

AudioPlayer

Represents an audio player.

Attributes

Name

Type

Readable

Writable

Description

src

string

Yes

Yes

URI of the audio resources

loop

boolean

Yes

Yes

Whether to loop audio playback

currentTime

number

Yes

No

Current playback position

duration

number

Yes

No

Playback duration

state

AudioState

Yes

No

Playback status

play()

Starts audio playback.

Example

audioplayer.src = 'common/mydream.mp3';
audioplayer.on('play', (err, action) => {
  if (err) {
     console.log(`err returned in play() callback`);
     return;
  }
  console.log('start to play');
  audioplayer.pause();
};
audioplayer.play();

pause()

Pauses audio playback.

Example

audioplayer.src = 'common/mydream.mp3';
audioplayer.on('pause', (err, action) => {
  if (err) {
     console.log(`err returned in pause() callback`);
     return;
  }
  console.log('playback pause');
};
audioplayer.pause();

stop()

Stops audio playback.

Example

audioplayer.src = 'common/mydream.mp3';
audioplayer.on('stop',(err, action) => {
  if (err) {
     console.log(`err returned in stop() callback`);
     return;
  }
  console.log('playback stop');
};
audioplayer.stop();

seek(number)

Goes to a specified playback position.

Parameters

Name

Type

Mandatory

Description

timeMs

number

Yes

Target playback position

Example

audioplayer.src = 'common/mydream.mp3';
audioplayer.on('timeupdate', (err, action) => {
  if (err) {
     console.log(`err returned in seek() callback`);
     return;
  }
  var newTime = audioplayer.currenTime;
  if(newTime = 30000) {
    console.info('Seek success, new time : ' + newTime);
  } else {
    console.info('Seek Failed');
  }
};
audioplayer.seek(30000);

setVolume(number)

Sets the volume.

Parameters

Name

Type

Mandatory

Description

vol

number

Yes

Volume to set

Example

audioplayer.src = 'common/mydream.mp3';
audioplayer.on('volumeChange', (err, action) => {
  if (err) {
     console.log(`err returned in setVolume() callback`);
     return;
  }
  console.log('playback volume change');
};
audioplayer.setVolume(30);

release()

Releases audio resources.

Example

audioplay.release();

Events

play

Triggered when play() is called

pause

Triggered when pause() is called

stop

Triggered when stop() is called

dataLoad

Triggered when audio data is loaded

timeUpdate

Triggered when the playback position changes

volumeChange

Triggered when playback volume changes

finish

Triggered when playback is finished

error

Triggered when a playback error occurs

Parameter

Type

Description

callback

ErrorCallback

Callback function for handling this event

AudioState

Describes playback status.

Parameter

Description

playing

The audio is being played.

paused

Audio playback is paused.

stopped

Audio playback is stopped.

1
https://gitee.com/yougl/docs.git
git@gitee.com:yougl/docs.git
yougl
docs
docs
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891