媒體服務

導入模塊

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

media.createAVPlayer9+

createAVPlayer(callback: AsyncCallback<AVPlayer>): void

異步方式創(chuàng)建音視頻播放實例，通過注冊回調(diào)函數(shù)獲取返回值。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

let avPlayer;

media.createAVPlayer((error, video) => {
  if (video != null) {
    avPlayer = video;
    console.info('createAVPlayer success');
  } else {
    console.error(`createAVPlayer fail, error message:${error.message}`);
  }
});

media.createAVPlayer9+

createAVPlayer(): Promise<AVPlayer>

異步方式創(chuàng)建音視頻播放實例，通過Promise獲取返回值。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

let avPlayer;

media.createAVPlayer().then((video) => {
  if (video != null) {
    avPlayer = video;
    console.info('createAVPlayer success');
  } else {
    console.error('createAVPlayer fail');
  }
}).catch((error) => {
  console.error(`AVPlayer catchCallback, error message:${error.message}`);
});

media.createAVRecorder9+

createAVRecorder(callback: AsyncCallback<AVRecorder>): void

異步方式創(chuàng)建音視頻錄制實例。通過注冊回調(diào)函數(shù)獲取返回值。

一臺設備只允許創(chuàng)建一個錄制實例。

注意，使用相機進行視頻錄制時，需要與相機模塊配合，當前相機模塊僅對系統(tǒng)應用開放。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

let avRecorder;

media.createAVRecorder((error, recorder) => {
  if (recorder != null) {
    avRecorder = recorder;
    console.info('createAVRecorder success');
  } else {
    console.error(`createAVRecorder fail, error message:${error.message}`);
  }
});

media.createAVRecorder9+

createAVRecorder(): Promise<AVRecorder>

異步方式創(chuàng)建音視頻錄制實例。通過Promise獲取返回值。

一臺設備只允許創(chuàng)建一個錄制實例。

注意，使用相機進行視頻錄制時，需要與相機模塊配合，當前相機模塊僅對系統(tǒng)應用開放。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

let avRecorder;

media.createAVRecorder().then((recorder) => {
  if (recorder != null) {
    avRecorder = recorder;
    console.info('createAVRecorder success');
  } else {
    console.error('createAVRecorder fail');
  }
}).catch((error) => {
  console.error(`createAVRecorder catchCallback, error message:${error.message}`);
});

AVErrorCode9+

媒體錯誤碼類型枚舉

系統(tǒng)能力： SystemCapability.Multimedia.Media.Core

MediaType8+

媒體類型枚舉。

系統(tǒng)能力： SystemCapability.Multimedia.Media.Core

CodecMimeType8+

Codec MIME類型枚舉。

系統(tǒng)能力： SystemCapability.Multimedia.Media.Core

MediaDescriptionKey8+

媒體信息描述枚舉。

系統(tǒng)能力： SystemCapability.Multimedia.Media.Core

BufferingInfoType8+

緩存事件類型枚舉。

系統(tǒng)能力： SystemCapability.Multimedia.Media.Core

StateChangeReason9+

表示播放或錄制實例狀態(tài)機切換原因的枚舉，伴隨state一起上報。

系統(tǒng)能力： SystemCapability.Multimedia.Media.Core

AVPlayer9+

播放管理類，用于管理和播放媒體資源。在調(diào)用AVPlayer的方法前，需要先通過createAVPlayer()構(gòu)建一個AVPlayer實例。

Audio/Video播放demo可參考：音頻播放開發(fā)指導、視頻播放開發(fā)指導。

屬性

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

說明：

將資源句柄（fd）傳遞給媒體播放器之后，請不要通過該資源句柄做其他讀寫操作，包括但不限于將同一個資源句柄傳遞給多個媒體播放器。同一時間通過同一個資源句柄讀寫文件時存在競爭關(guān)系，將導致播放異常。

on('stateChange')9+

on(type: 'stateChange', callback: (state: AVPlayerState, reason: StateChangeReason) => void): void

監(jiān)聽播放狀態(tài)機AVPlayerState切換的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('stateChange', async (state, reason) => {
  switch (state) {
    case 'idle':
      console.info('state idle called')
      break;
    case 'initialized':
      console.info('initialized prepared called')
      break;
    case 'prepared':
      console.info('state prepared called')
      break;
    case 'playing':
      console.info('state playing called')
      break;
    case 'paused':
      console.info('state paused called')
      break;
    case 'completed':
      console.info('state completed called')
      break;
    case 'stopped':
      console.info('state stopped called')
      break;
    case 'released':
      console.info('state released called')
      break;
    case 'error':
      console.info('state error called')
      break;
    default:
      console.info('unkown state :' + state)
      break;
  }
})

off('stateChange')9+

off(type: 'stateChange'): void

取消監(jiān)聽播放狀態(tài)機AVPlayerState切換的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('stateChange')

on('error')9+

on(type: 'error', callback: ErrorCallback): void

監(jiān)聽AVPlayer的錯誤事件，該事件僅用于錯誤提示，不需要用戶停止播控動作。如果此時AVPlayerState也切至error狀態(tài)，用戶需要通過reset()或者release()退出播放操作。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

AVPlayer回調(diào)的錯誤分類可以分為以下幾種：

示例：

avPlayer.on('error', (error) => {
  console.error('error happened,and error message is :' + error.message)
  console.error('error happened,and error code is :' + error.code)
})

off('error')9+

off(type: 'error'): void

取消監(jiān)聽播放的錯誤事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('error')

prepare9+

prepare(callback: AsyncCallback<void>): void

通過回調(diào)方式準備播放視頻，需在stateChange事件成功觸發(fā)至initialized狀態(tài)后，才能調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avPlayer.prepare((err) => {
  if (err == null) {
    console.info('prepare success');
  } else {
    console.error('prepare filed,error message is :' + err.message)
  }
})

prepare9+

prepare(): Promise<void>

通過Promise方式準備播放視頻，需在stateChange事件成功觸發(fā)至initialized狀態(tài)后，才能調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avPlayer.prepare().then(() => {
  console.info('prepare success');
}, (err) => {
  console.error('prepare filed,error message is :' + err.message)
})

play9+

play(callback: AsyncCallback<void>): void

通過回調(diào)方式開始播放音視頻資源，只能在prepared/paused/complete狀態(tài)調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avPlayer.play((err) => {
  if (err == null) {
    console.info('play success');
  } else {
    console.error('play filed,error message is :' + err.message)
  }
})

play9+

play(): Promise<void>

通過Promise方式開始播放音視頻資源，只能在prepared/paused/complete狀態(tài)調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

avPlayer.play().then(() => {
  console.info('play success');
}, (err) => {
  console.error('play filed,error message is :' + err.message)
})

pause9+

pause(callback: AsyncCallback<void>): void

通過回調(diào)方式暫停播放音視頻資源，只能在playing狀態(tài)調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

avPlayer.pause((err) => {
  if (err == null) {
    console.info('pause success');
  } else {
    console.error('pause filed,error message is :' + err.message)
  }
})

pause9+

pause(): Promise<void>

通過Promise方式暫停播放音視頻資源，只能在playing狀態(tài)調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

avPlayer.pause().then(() => {
  console.info('pause success');
}, (err) => {
  console.error('pause filed,error message is :' + err.message)
})

stop9+

stop(callback: AsyncCallback<void>): void

通過回調(diào)方式停止播放音視頻資源，只能在prepared/playing/paused/complete狀態(tài)調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

avPlayer.stop((err) => {
  if (err == null) {
    console.info('stop success');
  } else {
    console.error('stop filed,error message is :' + err.message)
  }
})

stop9+

stop(): Promise<void>

通過Promise方式停止播放音視頻資源，只能在prepared/playing/paused/complete狀態(tài)調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

avPlayer.stop().then(() => {
  console.info('stop success');
}, (err) => {
  console.error('stop filed,error message is :' + err.message)
})

reset9+

reset(callback: AsyncCallback<void>): void

通過回調(diào)方式重置播放，只能在initialized/prepared/playing/paused/complete/stopped/error狀態(tài)調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

avPlayer.reset((err) => {
  if (err == null) {
    console.info('reset success');
  } else {
    console.error('reset filed,error message is :' + err.message)
  }
})

reset9+

reset(): Promise<void>

通過Promise方式通過Promise方式重置播放，只能在initialized/prepared/playing/paused/complete/stopped/error狀態(tài)調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

avPlayer.reset().then(() => {
  console.info('reset success');
}, (err) => {
  console.error('reset filed,error message is :' + err.message)
})

release9+

release(callback: AsyncCallback<void>): void

通過回調(diào)方式銷毀播放資源，除released狀態(tài)，都可以調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

avPlayer.release((err) => {
  if (err == null) {
    console.info('reset success');
  } else {
    console.error('release filed,error message is :' + err.message)
  }
})

release9+

release(): Promise<void>

通過Promise方式通過Promise方式銷毀播放，除released狀態(tài)，都可以調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

avPlayer.release().then(() => {
  console.info('release success');
}, (err) => {
  console.error('release filed,error message is :' + err.message)
})

getTrackDescription9+

getTrackDescription(callback: AsyncCallback<Array<MediaDescription>>): void

通過回調(diào)方式獲取音視頻軌道信息，可以在prepared/playing/paused狀態(tài)調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

function printfDescription(obj) {
  for (let item in obj) {
    let property = obj[item];
    console.info('audio key is ' + item);
    console.info('audio value is ' + property);
  }
}

avPlayer.getTrackDescription((error, arrList) => {
  if ((arrList) != null) {
    for (let i = 0; i < arrList.length; i++) {
      printfDescription(arrList[i]);
    }
  } else {
    console.log(`video getTrackDescription fail, error:${error}`);
  }
});

getTrackDescription9+

getTrackDescription(): Promise<Array<MediaDescription>>

通過Promise方式獲取音視頻軌道信息，可以在prepared/playing/paused狀態(tài)調(diào)用。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

let arrayDescription;

function printfDescription(obj) {
  for (let item in obj) {
    let property = obj[item];
    console.info('audio key is ' + item);
    console.info('audio value is ' + property);
  }
}

avPlayer.getTrackDescription().then((arrList) => {
  if (arrList != null) {
    arrayDescription = arrList;
  } else {
    console.log('video getTrackDescription fail');
  }
}).catch((error) => {
  console.info(`video catchCallback, error:${error}`);
});
for (let i = 0; i < arrayDescription.length; i++) {
  printfDescription(arrayDescription[i]);
}

seek9+

seek(timeMs: number, mode?:SeekMode): void

跳轉(zhuǎn)到指定播放位置，只能在prepared/playing/paused/complete狀態(tài)調(diào)用，可以通過seekDone事件確認是否生效。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

let seekTime = 1000
avPlayer.seek(seekTime, media.SeekMode.SEEK_PREV_SYNC)

on('seekDone')9+

on(type: 'seekDone', callback: Callback<number>): void

監(jiān)聽seek生效的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('seekDone', (seekDoneTime:number) => {
  console.info('seekDone success,and seek time is:' + seekDoneTime)
})

off('seekDone')9+

off(type: 'seekDone'): void

取消監(jiān)聽seek生效的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('seekDone')

setSpeed9+

setSpeed(speed: PlaybackSpeed): void

設置倍速模式，只能在prepared/playing/paused/complete狀態(tài)調(diào)用，可以通過speedDone事件確認是否生效。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.setSpeed(media.PlaybackSpeed.SPEED_FORWARD_2_00_X)

on('speedDone')9+

on(type: 'speedDone', callback: Callback<number>): void

監(jiān)聽setSpeed生效的事件

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('speedDone', (speed:number) => {
  console.info('speedDone success,and speed value is:' + speed)
})

off('speedDone')9+

off(type: 'speedDone'): void

取消監(jiān)聽setSpeed生效的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('speedDone')

setBitrate9+

setBitrate(bitrate: number): void

選擇要播放的指定比特率，僅對HLS協(xié)議網(wǎng)絡流有效，只能在prepared/playing/paused/complete狀態(tài)調(diào)用，可以通過bitrateDone事件確認是否生效。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

let bitrate = 96000
avPlayer.setBitrate(bitrate)

on('bitrateDone')9+

on(type: 'bitrateDone', callback: Callback<number>): void

監(jiān)聽setBitrate生效的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('bitrateDone', (bitrate:number) => {
  console.info('bitrateDone success,and bitrate value is:' + bitrate)
})

off('bitrateDone')9+

off(type: 'bitrateDone'): void

取消監(jiān)聽setBitrate生效的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('bitrateDone')

on('availableBitrates')9+

on(type: 'availableBitrates', callback: (bitrates: Array<number>) => void): void

監(jiān)聽HLS協(xié)議流可用的比特率列表，只會在切換prepared狀態(tài)后上報。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('availableBitrates', (bitrates: Array<number>) => {
  console.info('availableBitrates success,and availableBitrates length is:' + bitrates.length)
})

off('availableBitrates')9+

off(type: 'availableBitrates'): void

取消監(jiān)聽HLS協(xié)議流可用的比特率列表。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('availableBitrates')

setVolume9+

setVolume(volume: number): void

設置媒體播放音量，只能在prepared/playing/paused/complete狀態(tài)調(diào)用，可以通過volumeChange事件確認是否生效。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

let volume = 1.0
avPlayer.setVolume(volume)

on('volumeChange')9+

on(type: 'volumeChange', callback: Callback<number>): void

監(jiān)聽setVolume生效的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('volumeChange', (vol:number) => {
  console.info('volumeChange success,and new volume is :' + vol)
})

off('volumeChange')9+

off(type: 'volumeChange'): void

取消監(jiān)聽setVolume生效的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('volumeChange')

on('endOfStream')9+

on(type: 'endOfStream', callback: Callback<void>): void

監(jiān)聽資源播放至結(jié)尾的事件；如果用戶設置loop=1，播放會跳轉(zhuǎn)至開頭重播；如果用戶沒有設置loop，會通過stateChange上報completed狀態(tài)。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('endOfStream', () => {
  console.info('endOfStream success')
})

off('endOfStream')9+

off(type: 'endOfStream'): void

取消監(jiān)聽資源播放至結(jié)尾的事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('endOfStream')

on('timeUpdate')9+

on(type: 'timeUpdate', callback: Callback<number>): void

監(jiān)聽資源播放當前時間，單位為毫秒（ms），用于刷新進度條當前位置，默認間隔1s時間上報，因用戶操作(seek)產(chǎn)生的時間變化會立刻上報。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('timeUpdate', (time:number) => {
  console.info('timeUpdate success,and new time is :' + time)
})

off('timeUpdate')9+

off(type: 'timeUpdate'): void

取消監(jiān)聽資源播放當前時間。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('timeUpdate')

on('durationUpdate')9+

on(type: 'durationUpdate', callback: Callback<number>): void

監(jiān)聽資源播放資源的時長，單位為毫秒（ms），用于刷新進度條長度，默認只在prepared上報一次，同時允許一些特殊碼流刷新多次時長。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('durationUpdate', (duration) => {
  console.info('durationUpdate success,new duration is :' + duration)
})

off('durationUpdate')9+

off(type: 'durationUpdate'): void

取消監(jiān)聽資源播放資源的時長。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('durationUpdate')

on('bufferingUpdate')9+

on(type: 'bufferingUpdate', callback: (infoType: BufferingInfoType, value: number) => void): void

訂閱音視頻緩存更新事件，僅網(wǎng)絡播放支持該訂閱事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('bufferingUpdate', (infoType: media.BufferingInfoType, value: number) => {
  console.info('bufferingUpdate success,and infoType value is:' + infoType + ', value is :' + value)
})

off('bufferingUpdate')9+

off(type: 'bufferingUpdate'): void

取消監(jiān)聽音視頻緩存更新事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('bufferingUpdate')

on('startRenderFrame')9+

on(type: 'startRenderFrame', callback: Callback<void>): void

訂閱視頻播放開始首幀渲染的更新事件，僅視頻播放支持該訂閱事件，該事件僅代表播放服務將第一幀畫面送顯示模塊，實際效果依賴顯示服務渲染性能。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('startRenderFrame', () => {
  console.info('startRenderFrame success')
})

off('startRenderFrame')9+

off(type: 'startRenderFrame'): void

取消監(jiān)聽視頻播放開始首幀渲染的更新事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('startRenderFrame')

on('videoSizeChange')9+

on(type: 'videoSizeChange', callback: (width: number, height: number) => void): void

監(jiān)聽視頻播放寬高變化事件，僅視頻播放支持該訂閱事件，默認只在prepread狀態(tài)上報一次，但HLS協(xié)議碼流會在切換分辨率時上報；

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.on('videoSizeChange', (width: number, height: number) => {
  console.info('videoSizeChange success,and width is:' + width + ', height is :' + height)
})

off('videoSizeChange')9+

off(type: 'videoSizeChange'): void

取消監(jiān)聽視頻播放寬高變化事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('videoSizeChange')

on('audioInterrupt')9+

on(type: 'audioInterrupt', callback: (info: audio.InterruptEvent) => void): void

監(jiān)聽音頻焦點變化事件，多個音視頻資源同時播放時，會根據(jù)音頻焦點模型audio.InterruptMode觸發(fā)此事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

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

avPlayer.on('audioInterrupt', (info: audio.InterruptEvent) => {
  console.info('audioInterrupt success,and InterruptEvent info is:' + info)
})

off('audioInterrupt')9+

off(type: 'audioInterrupt'): void

取消監(jiān)聽音頻焦點變化事件。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

參數(shù)：

示例：

avPlayer.off('audioInterrupt')

AVPlayerState9+

AVPlayer的狀態(tài)機，可通過state屬性主動獲取當前狀態(tài)，也可通過監(jiān)聽stateChange事件上報當前狀態(tài)，狀態(tài)機之間的切換規(guī)則，可參考使用AVPlayer開發(fā)音頻播放功能。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVPlayer

AVFileDescriptor9+

音視頻文件資源描述，一種特殊資源的播放方式，使用場景：應用中的音頻資源被連續(xù)存儲在同一個文件中，需要根據(jù)偏移量和長度進行播放。

系統(tǒng)能力： SystemCapability.Multimedia.Media.Core

SeekMode8+

視頻播放的Seek模式枚舉，可通過seek方法作為參數(shù)傳遞下去。

系統(tǒng)能力： SystemCapability.Multimedia.Media.Core

PlaybackSpeed8+

視頻播放的倍速枚舉，可通過setSpeed方法作為參數(shù)傳遞下去。

系統(tǒng)能力： SystemCapability.Multimedia.Media.VideoPlayer

VideoScaleType9+

枚舉，視頻縮放模式。

系統(tǒng)能力： SystemCapability.Multimedia.Media.VideoPlayer

MediaDescription8+

通過key-value方式獲取媒體信息。

系統(tǒng)能力： SystemCapability.Multimedia.Media.Core

示例：

import media from '@ohos.multimedia.media'
function printfItemDescription(obj, key) {
  let property = obj[key];
  console.info('audio key is ' + key); // 通過key值獲取對應的value。key值具體可見[MediaDescriptionKey]
  console.info('audio value is ' + property); //對應key值得value。其類型可為任意類型，具體key對應value的類型可參考[MediaDescriptionKey]
}
let audioPlayer = media.createAudioPlayer();
audioPlayer.getTrackDescription((error, arrList) => {
  if (arrList != null) {
    for (let i = 0; i < arrList.length; i++) {
      printfItemDescription(arrList[i], media.MediaDescriptionKey.MD_KEY_TRACK_TYPE);  //打印出每條軌道MD_KEY_TRACK_TYPE的值
    }
  } else {
    console.log(`audio getTrackDescription fail, error:${error}`);
  }
});

AVRecorder9+

音視頻錄制管理類，用于音視頻媒體錄制。在調(diào)用AVRecorder的方法前，需要先通過createAVRecorder()構(gòu)建一個AVRecorder實例。

音視頻錄制demo可參考：使用AVRecorder開發(fā)音頻錄制功能

注意，使用相機進行視頻錄制時，需要與相機模塊配合，當前相機模塊僅對系統(tǒng)應用開放。

屬性

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

prepare9+

prepare(config: AVRecorderConfig, callback: AsyncCallback<void>): void

異步方式進行音視頻錄制的參數(shù)設置。通過注冊回調(diào)函數(shù)獲取返回值。

需要權(quán)限： ohos.permission.MICROPHONE

不涉及音頻錄制時，可以不需要獲取ohos.permission.MICROPHONE權(quán)限。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

// 配置參數(shù)以實際硬件設備支持的范圍為準
let AVRecorderProfile = {
  audioBitrate : 48000,
  audioChannels : 2,
  audioCodec : media.CodecMimeType.AUDIO_AAC,
  audioSampleRate : 48000,
  fileFormat : media.ContainerFormatType.CFT_MPEG_4,
  videoBitrate : 2000000,
  videoCodec : media.CodecMimeType.VIDEO_AVC,
  videoFrameWidth : 640,
  videoFrameHeight : 480,
  videoFrameRate : 30
}
let AVRecorderConfig = {
  audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
  videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
  profile : AVRecorderProfile,
  url : 'fd://', // 文件需先由調(diào)用者創(chuàng)建，賦予讀寫權(quán)限，將文件fd傳給此參數(shù)，eg.fd://45
  rotation : 0, // 合理值0、90、180、270，非合理值prepare接口將報錯
  location : { latitude : 30, longitude : 130 }
}

avRecorder.prepare(AVRecorderConfig, (err) => {
  if (err == null) {
    console.info('prepare success');
  } else {
    console.error('prepare failed and error is ' + err.message);
  }
})

prepare9+

prepare(config: AVRecorderConfig): Promise<void>

異步方式進行音視頻錄制的參數(shù)設置。通過Promise獲取返回值。

需要權(quán)限： ohos.permission.MICROPHONE

不涉及音頻錄制時，可以不需要獲ohos.permission.MICROPHONE權(quán)限。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorde

參數(shù)：

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

// 配置參數(shù)以實際硬件設備支持的范圍為準
let AVRecorderProfile = {
  audioBitrate : 48000,
  audioChannels : 2,
  audioCodec : media.CodecMimeType.AUDIO_AAC,
  audioSampleRate : 48000,
  fileFormat : media.ContainerFormatType.CFT_MPEG_4,
  videoBitrate : 2000000,
  videoCodec : media.CodecMimeType.VIDEO_AVC,
  videoFrameWidth : 640,
  videoFrameHeight : 480,
  videoFrameRate : 30
}
let AVRecorderConfig = {
  audioSourceType : media.AudioSourceType.AUDIO_SOURCE_TYPE_MIC,
  videoSourceType : media.VideoSourceType.VIDEO_SOURCE_TYPE_SURFACE_YUV,
  profile : AVRecorderProfile,
  url : 'fd://',  // 文件需先由調(diào)用者創(chuàng)建，賦予讀寫權(quán)限，將文件fd傳給此參數(shù)，eg.fd://45
  rotation : 0, // 合理值0、90、180、270，非合理值prepare接口報錯
  location : { latitude : 30, longitude : 130 }
}

avRecorder.prepare(AVRecorderConfig).then(() => {
  console.info('prepare success');
}).catch((err) => {
  console.error('prepare failed and catch error is ' + err.message);
});

getInputSurface9+

getInputSurface(callback: AsyncCallback<string>): void

異步方式獲得錄制需要的surface。此surface提供給調(diào)用者，調(diào)用者從此surface中獲取surfaceBuffer，填入相應的視頻數(shù)據(jù)。

應當注意，填入的視頻數(shù)據(jù)需要攜帶時間戳（單位ns）和buffersize。時間戳的起始時間請以系統(tǒng)啟動時間為基準。

需在prepare()事件成功觸發(fā)后，才能調(diào)用getInputSurface()方法。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

let surfaceID = null; // 該surfaceID用于傳遞給相機接口創(chuàng)造videoOutput

avRecorder.getInputSurface((err, surfaceId) => {
  if (err == null) {
    console.info('getInputSurface success');
    surfaceID = surfaceId;
  } else {
    console.error('getInputSurface failed and error is ' + err.message);
  }
});

getInputSurface9+

getInputSurface(): Promise<string>

異步方式獲得錄制需要的surface。此surface提供給調(diào)用者，調(diào)用者從此surface中獲取surfaceBuffer，填入相應的視頻數(shù)據(jù)。

應當注意，填入的視頻數(shù)據(jù)需要攜帶時間戳（單位ns）和buffersize。時間戳的起始時間請以系統(tǒng)啟動時間為基準。

需在prepare()事件成功觸發(fā)后，才能調(diào)用getInputSurface方法。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼

示例：

let surfaceID = null; // 該surfaceID用于傳遞給相機接口創(chuàng)造videoOutput

avRecorder.getInputSurface().then((surfaceId) => {
  console.info('getInputSurface success');
  surfaceID = surfaceId;
}).catch((err) => {
  console.error('getInputSurface failed and catch error is ' + err.message);
});

start9+

start(callback: AsyncCallback<void>): void

異步方式開始視頻錄制。通過注冊回調(diào)函數(shù)獲取返回值。

純音頻錄制需在prepare()事件成功觸發(fā)后，才能調(diào)用start方法。純視頻錄制，音視頻錄制需在getInputSurface()事件成功觸發(fā)后，才能調(diào)用start方法。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avRecorder.start((err) => {
  if (err == null) {
    console.info('start AVRecorder success');
  } else {
    console.error('start AVRecorder failed and error is ' + err.message);
  }
});

start9+

start(): Promise<void>

異步方式開始視頻錄制。通過Promise獲取返回值。

純音頻錄制需在prepare()事件成功觸發(fā)后，才能調(diào)用start方法。純視頻錄制，音視頻錄制需在getInputSurface()事件成功觸發(fā)后，才能調(diào)用start方法。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avRecorder.start().then(() => {
  console.info('start AVRecorder success');
}).catch((err) => {
  console.error('start AVRecorder failed and catch error is ' + err.message);
});

pause9+

pause(callback: AsyncCallback<void>): void

異步方式暫停視頻錄制。通過注冊回調(diào)函數(shù)獲取返回值。

需要start()事件成功觸發(fā)后，才能調(diào)用pause方法，可以通過調(diào)用resume()接口來恢復錄制。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avRecorder.pause((err) => {
  if (err == null) {
    console.info('pause AVRecorder success');
  } else {
    console.error('pause AVRecorder failed and error is ' + err.message);
  }
});

pause9+

pause(): Promise<void>

異步方式暫停視頻錄制。通過Promise獲取返回值。

需要start()事件成功觸發(fā)后，才能調(diào)用pause方法，可以通過調(diào)用resume()接口來恢復錄制。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avRecorder.pause().then(() => {
  console.info('pause AVRecorder success');
}).catch((err) => {
  console.error('pause AVRecorder failed and catch error is ' + err.message);
});

resume9+

resume(callback: AsyncCallback<void>): void

異步方式恢復視頻錄制。通過注冊回調(diào)函數(shù)獲取返回值。

需要在pause()事件成功觸發(fā)后，才能調(diào)用resume方法。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avRecorder.resume((err) => {
  if (err == null) {
    console.info('resume AVRecorder success');
  } else {
    console.error('resume AVRecorder failed and error is ' + err.message);
  }
});

resume9+

resume(): Promise<void>

異步方式恢復視頻錄制。通過Promise獲取返回值。

需要在pause()事件成功觸發(fā)后，才能調(diào)用resume方法。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avRecorder.resume().then(() => {
  console.info('resume AVRecorder success');
}).catch((err) => {
  console.error('resume AVRecorder failed and catch error is ' + err.message);
});

stop9+

stop(callback: AsyncCallback<void>): void

異步方式停止視頻錄制。通過注冊回調(diào)函數(shù)獲取返回值。

需要在start()或pause()事件成功觸發(fā)后，才能調(diào)用stop方法。

純音頻錄制時，需要重新調(diào)用prepare()接口才能重新錄制。純視頻錄制，音視頻錄制時，需要重新調(diào)用prepare()和getInputSurface()接口才能重新錄制。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avRecorder.stop((err) => {
  if (err == null) {
    console.info('stop AVRecorder success');
  } else {
    console.error('stop AVRecorder failed and error is ' + err.message);
  }
});

stop9+

stop(): Promise<void>

異步方式停止視頻錄制。通過Promise獲取返回值。

需要在start()或pause()事件成功觸發(fā)后，才能調(diào)用stop方法。

純音頻錄制時，需要重新調(diào)用prepare()接口才能重新錄制。純視頻錄制，音視頻錄制時，需要重新調(diào)用prepare()和getInputSurface()接口才能重新錄制。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avRecorder.stop().then(() => {
  console.info('stop AVRecorder success');
}).catch((err) => {
  console.error('stop AVRecorder failed and catch error is ' + err.message);
});

reset9+

reset(callback: AsyncCallback<void>): void

異步方式重置音視頻錄制。通過注冊回調(diào)函數(shù)獲取返回值。

純音頻錄制時，需要重新調(diào)用prepare()接口才能重新錄制。純視頻錄制，音視頻錄制時，需要重新調(diào)用prepare()和getInputSurface()接口才能重新錄制。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

參數(shù)：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。

示例：

avRecorder.reset((err) => {
  if (err == null) {
    console.info('reset AVRecorder success');
  } else {
    console.error('reset AVRecorder failed and error is ' + err.message);
  }
});

reset9+

reset(): Promise<void>

異步方式重置音視頻錄制。通過Promise獲取返回值。

純音頻錄制時，需要重新調(diào)用prepare()接口才能重新錄制。純視頻錄制，音視頻錄制時，需要重新調(diào)用prepare()和getInputSurface()接口才能重新錄制。

系統(tǒng)能力： SystemCapability.Multimedia.Media.AVRecorder

返回值：

錯誤碼：

以下錯誤碼的詳細介紹請參見媒體錯誤碼。