!2190 媒体指南修复

Merge pull request !2190 from zengyawen/master

zh-cn/application-dev/media/audio-playback.md

@@ -25,6 +25,9 @@
 AudioPlayer支持的src媒体源输入类型可参考：[src属性说明](../reference/apis/js-apis-media.md#audioplayer_属性)
 
 ```js
+import media from '@ohos.multimedia.media'
+import fileIO from '@ohos.fileio'
+
 function SetCallBack(audioPlayer) {
     audioPlayer.on('dataLoad', () => {              //设置'dataLoad'事件回调，src属性设置成功后，触发此回调
         console.info('audio set source success');
@@ -80,7 +83,18 @@ function printfDescription(obj) {
 let audioPlayer = media.createAudioPlayer();
 SetCallBack(audioPlayer);                          //设置事件回调
 //2、用户选择音频，设置uri
-audioPlayer.src = 'file:///data/data/ohos.xxx.xxx/files/test.mp3';  //设置src属性，并触发'dataLoad'事件回调
+let fdPath = 'fd://'
+let path = 'data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp3';
+await fileIO.open(path).then(fdNumber) => {
+   fdPath = fdPath + '' + fdNumber;
+   console.info('open fd sucess fd is' + fdPath);
+}, (err) => {
+   console.info('open fd failed err is' + err);
+}),catch((err) => {
+   console.info('open fd failed err is' + err);
+});
+
+audioPlayer.src = fdPath;                         //设置src属性，并触发'dataLoad'事件回调
 //3、播放音频
 audioPlayer.play();                               //需等待'dataLoad'事件回调完成后，才可调用play进行播放，触发'play'事件回调
 //4、跳转播放位置
@@ -111,6 +125,9 @@ audioPlayer = undefined;
 ### 正常播放场景
 
 ```js
+import media from '@ohos.multimedia.media'
+import fileIO from '@ohos.fileio'
+
 function SetCallBack(audioPlayer) {
     audioPlayer.on('dataLoad', () => {              //设置'dataLoad'事件回调，src属性设置成功后，触发此回调
         console.info('audio set source success');
@@ -128,13 +145,27 @@ function SetCallBack(audioPlayer) {
 
 let audioPlayer = media.createAudioPlayer();       //创建一个音频播放实例
 SetCallBack(audioPlayer);                          //设置事件回调
-/* 用户选择音频，设置uri */
-audioPlayer.src = 'file:///data/data/ohos.xxx.xxx/files/test.mp3';  //设置src属性，并触发'dataLoad'事件回调
+/* 用户选择视频设置fd(本地播放) */
+let fdPath = 'fd://'
+let path = 'data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp3';
+await fileIO.open(path).then(fdNumber) => {
+   fdPath = fdPath + '' + fdNumber;
+   console.info('open fd sucess fd is' + fdPath);
+}, (err) => {
+   console.info('open fd failed err is' + err);
+}),catch((err) => {
+   console.info('open fd failed err is' + err);
+});
+
+audioPlayer.src = fdPath;                           //设置src属性，并触发'dataLoad'事件回调
 ```
 
 ### 切歌场景
 
 ```js
+import media from '@ohos.multimedia.media'
+import fileIO from '@ohos.fileio'
+
 function SetCallBack(audioPlayer) {
     audioPlayer.on('dataLoad', () => {              //设置'dataLoad'事件回调，src属性设置成功后，触发此回调
         console.info('audio set source success');
@@ -152,16 +183,42 @@ function SetCallBack(audioPlayer) {
 
 let audioPlayer = media.createAudioPlayer();       //创建一个音频播放实例
 SetCallBack(audioPlayer);                          //设置事件回调
-/* 用户选择音频，设置uri */
-audioPlayer.src = 'file:///data/data/ohos.xxx.xxx/files/test.mp3';  //设置src属性，并触发'dataLoad'事件回调
+/* 用户选择视频设置fd(本地播放) */
+let fdPath = 'fd://'
+let path = 'data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp3';
+await fileIO.open(path).then(fdNumber) => {
+   fdPath = fdPath + '' + fdNumber;
+   console.info('open fd sucess fd is' + fdPath);
+}, (err) => {
+   console.info('open fd failed err is' + err);
+}),catch((err) => {
+   console.info('open fd failed err is' + err);
+});
+
+audioPlayer.src = fdPath;                           //设置src属性，并触发'dataLoad'事件回调
 /* 播放一段时间后，下发切歌指令 */
 audioPlayer.reset();
-audioPlayer.src = 'file:///data/data/ohos.xxx.xxx/files/next.mp3';
+
+/* 用户选择视频设置fd(本地播放) */
+let fdNextPath = 'fd://'
+let nextPath = 'data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp3';
+await fileIO.open(nextPath).then(fdNumber) => {
+   fdNextPath = fdNextPath + '' + fdNumber;
+   console.info('open fd sucess fd is' + fdNextPath);
+}, (err) => {
+   console.info('open fd failed err is' + err);
+}),catch((err) => {
+   console.info('open fd failed err is' + err);
+});
+audioPlayer.src = fdNextPath;
 ```
 
 ### 单曲循环场景
 
 ```js
+import media from '@ohos.multimedia.media'
+import fileIO from '@ohos.fileio'
+
 function SetCallBack(audioPlayer) {
     audioPlayer.on('dataLoad', () => {              //设置'dataLoad'事件回调，src属性设置成功后，触发此回调
         console.info('audio set source success');
@@ -179,7 +236,19 @@ function SetCallBack(audioPlayer) {
 
 let audioPlayer = media.createAudioPlayer();       //创建一个音频播放实例
 SetCallBack(audioPlayer);                          //设置事件回调
-/* 用户选择音频，设置uri */
-audioPlayer.src = 'file:///data/data/ohos.xxx.xxx/files/test.mp3';  //设置src属性，并触发'dataLoad'事件回调
-audioPlayer.loop = true;                           //设置循环播放属性
+
+/* 用户选择视频设置fd(本地播放) */
+let fdPath = 'fd://'
+let path = 'data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp3';
+await fileIO.open(path).then(fdNumber) => {
+   fdPath = fdPath + '' + fdNumber;
+   console.info('open fd sucess fd is' + fdPath);
+}, (err) => {
+   console.info('open fd failed err is' + err);
+}),catch((err) => {
+   console.info('open fd failed err is' + err);
+});
+
+audioPlayer.src = fdPath;                           //设置src属性，并触发'dataLoad'事件回调
+audioPlayer.loop = true;                            //设置循环播放属性
 ```
\ No newline at end of file

zh-cn/application-dev/media/audio-recorder.md

@@ -23,6 +23,11 @@
 包含流程：创建实例，设置录制参数，录制音频，暂停录制，恢复录制，停止录制，释放资源等流程。
 
 ```js
+import media from '@ohos.multimedia.media'
+import mediaLibrary from '@ohos.multimedia.mediaLibrary'
+
+let testFdNumber;
+
 function SetCallBack(audioRecorder) {
     audioRecorder.on('prepare', () => {              								// 设置'prepare'事件回调
         console.log('prepare success');    
@@ -57,6 +62,31 @@ function SetCallBack(audioRecorder) {
     });
 }
 
+// pathName是传入的录制文件名，例如：01.mp3，生成后的文件地址：/storage/media/100/local/files/Movies/01.mp3
+// 使用mediaLibrary需要添加以下权限, ohos.permission.MEDIA_LOCATION、ohos.permission.WRITE_MEDIA、ohos.permission.READ_MEDIA
+async function getFd(pathName) {
+    let displayName = pathName;
+    const mediaTest = mediaLibrary.getMediaLibrary();
+    let fileKeyObj = mediaLibrary.FileKey;
+    let mediaType = mediaLibrary.MediaType.VIDEO;
+    let publicPath = await mediaTest.getPublicDirectory(mediaLibrary.DirectoryType.DIR_VIDEO);
+    let dataUri = await mediaTest.createAsset(mediaType, displayName, publicPath);
+    if (dataUri != undefined) {
+        let args = dataUri.id.toString();
+        let fetchOp = {
+            selections : fileKeyObj.ID + "=?",
+            selectionArgs : [args],
+        }
+        let fetchFileResult = await mediaTest.getFileAssets(fetchOp);
+        let fileAsset = await fetchFileResult.getAllObject();
+        let fdNumber = await fileAsset[0].open('Rw');
+        fdNumber = "fd://" + fdNumber.toString();
+        testFdNumber = fdNumber;
+    }
+}
+
+await getFd('01.mp3');
+
 // 1.创建实例
 let audioRecorder = media.createAudioRecorder();    
 // 2.设置回调
@@ -68,7 +98,7 @@ let audioRecorderConfig = {
     audioSampleRate : 22050,
     numberOfChannels : 2,
     format : media.AudioOutputFormat.AAC_ADTS,
-    uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a',       // 文件需先由调用者创建，并给予适当的权限
+    uri : testFdNumber,                             // testFdNumber由getFd生成
     location : { latitude : 30, longitude : 130},
 }																					
 audioRecorder.prepare(audioRecorderConfig);
@@ -92,7 +122,12 @@ audioRecorder = undefined;
 与全流程场景不同，不包括暂停录制，恢复录制的过程。
 
 ```js
-function SetCallBack(audioRecorder) {
+import media from '@ohos.multimedia.media'
+import mediaLibrary from '@ohos.multimedia.mediaLibrary'
+
+let testFdNumber;
+
+function SetCallBack(audioPlayer) {
     audioRecorder.on('prepare', () => {              								// 设置'prepare'事件回调
         console.log('prepare success');    
         // 录制界面可切换至已准备好，可点击录制按钮进行录制
@@ -108,6 +143,32 @@ function SetCallBack(audioRecorder) {
         console.log('audio recorder release success');
     });    
 }
+
+// pathName是传入的录制文件名，例如：01.mp3，生成后的文件地址：/storage/media/100/local/files/Movies/01.mp3
+// 使用mediaLibrary需要添加以下权限, ohos.permission.MEDIA_LOCATION、ohos.permission.WRITE_MEDIA、ohos.permission.READ_MEDIA
+async function getFd(pathName) {
+    let displayName = pathName;
+    const mediaTest = mediaLibrary.getMediaLibrary();
+    let fileKeyObj = mediaLibrary.FileKey;
+    let mediaType = mediaLibrary.MediaType.VIDEO;
+    let publicPath = await mediaTest.getPublicDirectory(mediaLibrary.DirectoryType.DIR_VIDEO);
+    let dataUri = await mediaTest.createAsset(mediaType, displayName, publicPath);
+    if (dataUri != undefined) {
+        let args = dataUri.id.toString();
+        let fetchOp = {
+            selections : fileKeyObj.ID + "=?",
+            selectionArgs : [args],
+        }
+        let fetchFileResult = await mediaTest.getFileAssets(fetchOp);
+        let fileAsset = await fetchFileResult.getAllObject();
+        let fdNumber = await fileAsset[0].open('Rw');
+        fdNumber = "fd://" + fdNumber.toString();
+        testFdNumber = fdNumber;
+    }
+}
+
+await getFd('01.mp3');
+
 // 1.创建实例
 let audioRecorder = media.createAudioRecorder();   
 // 2.设置回调
@@ -119,7 +180,7 @@ let audioRecorderConfig = {
     audioSampleRate : 22050,
     numberOfChannels : 2,
     format : media.AudioOutputFormat.AAC_ADTS,
-    uri : 'file:///data/accounts/account_0/appdata/appdata/recorder/test.m4a',      // 文件需先由调用者创建，并给予适当的权限
+    uri : testFdNumber,                             // testFdNumber由getFd生成
     location : { latitude : 30, longitude : 130},
 }
 audioRecorder.prepare(audioRecorderConfig)

zh-cn/application-dev/media/video-playback.md

@@ -30,10 +30,21 @@
 
 VideoPlayer支持的url媒体源输入类型可参考：[url属性说明](../reference/apis/js-apis-media.md#videoplayer_属性)
 
+Xcomponent创建方法可参考：[Xcomponent创建方法](#Xcomponent创建方法)
+
 ```js
+import media from '@ohos.multimedia.media'
+import fileIO from '@ohos.fileio'
+
 let videoPlayer = undefined; // 用于保存createVideoPlayer创建的对象
 let surfaceID = undefined; // 用于保存Xcomponent接口返回的surfaceID
 
+// 调用Xcomponent的接口用于获取surfaceID，并保存在surfaceID变量中，该接口由XComponent组件默认加载，非主动调用
+LoadXcomponent() {
+	surfaceID = this.$element('Xcomponent').getXComponentSurfaceId();
+    console.info('LoadXcomponent surfaceID is' + surfaceID);
+}
+
 // 函数调用发生错误时用于上报错误信息
 function failureCallback(error) {
     console.info(`error happened,error Name is ${error.name}`);
@@ -67,10 +78,19 @@ await media.createVideoPlayer().then((video) => {
     }
 }, failureCallback).catch(catchCallback);
 
-// 用户选择视频设置url
-videoPlayer.url = 'file:///data/data/ohos.xxx.xxx/files/test.mp4';
+// 用户选择视频设置fd(本地播放)
+let fdPath = 'fd://'
+let path = 'data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp4';
+await fileIO.open(path).then(fdNumber) => {
+   fdPath = fdPath + '' + fdNumber;
+   console.info('open fd sucess fd is' + fdPath);
+}, (err) => {
+   console.info('open fd failed err is' + err);
+}),catch((err) => {
+   console.info('open fd failed err is' + err);
+});
 
-// 该处需要调用Xcomponent的接口用于获取surfaceID，并保存在surfaceID变量中
+videoPlayer.url = fdPath;
 
 // 设置surfaceID用于显示视频画面
 await videoPlayer.setDisplaySurface(surfaceID).then(() => {
@@ -147,9 +167,18 @@ surfaceID = undefined;
 ### 正常播放场景
 
 ```js
+import media from '@ohos.multimedia.media'
+import fileIO from '@ohos.fileio'
+
 let videoPlayer = undefined; // 用于保存createVideoPlayer创建的对象
 let surfaceID = undefined; // 用于保存Xcomponent接口返回的surfaceID
 
+// 调用Xcomponent的接口用于获取surfaceID，并保存在surfaceID变量中，该接口由XComponent组件默认加载，非主动调用
+LoadXcomponent() {
+	surfaceID = this.$element('Xcomponent').getXComponentSurfaceId();
+    console.info('LoadXcomponent surfaceID is' + surfaceID);
+}
+
 // 函数调用发生错误时用于上报错误信息
 function failureCallback(error) {
     console.info(`error happened,error Name is ${error.name}`);
@@ -191,10 +220,19 @@ await media.createVideoPlayer().then((video) => {
 // 设置事件回调
 SetCallBack(videoPlayer);
 
-// 用户选择视频设置url
-videoPlayer.url = 'file:///data/data/ohos.xxx.xxx/files/test.mp4';
+// 用户选择视频设置fd(本地播放)
+let fdPath = 'fd://'
+let path = 'data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp4';
+await fileIO.open(path).then(fdNumber) => {
+   fdPath = fdPath + '' + fdNumber;
+   console.info('open fd sucess fd is' + fdPath);
+}, (err) => {
+   console.info('open fd failed err is' + err);
+}),catch((err) => {
+   console.info('open fd failed err is' + err);
+});
 
-// 该处需要调用Xcomponent的接口用于获取surfaceID，并保存在surfaceID变量中
+videoPlayer.url = fdPath;
 
 // 设置surfaceID用于显示视频画面
 await videoPlayer.setDisplaySurface(surfaceID).then(() => {
@@ -215,9 +253,18 @@ await videoPlayer.play().then(() => {
 ### 切视频场景
 
 ```js
+import media from '@ohos.multimedia.media'
+import fileIO from '@ohos.fileio'
+
 let videoPlayer = undefined; // 用于保存createVideoPlayer创建的对象
 let surfaceID = undefined; // 用于保存Xcomponent接口返回的surfaceID
 
+// 调用Xcomponent的接口用于获取surfaceID，并保存在surfaceID变量中，该接口由XComponent组件默认加载，非主动调用
+LoadXcomponent() {
+	surfaceID = this.$element('Xcomponent').getXComponentSurfaceId();
+    console.info('LoadXcomponent surfaceID is' + surfaceID);
+}
+
 // 函数调用发生错误时用于上报错误信息
 function failureCallback(error) {
     console.info(`error happened,error Name is ${error.name}`);
@@ -259,10 +306,19 @@ await media.createVideoPlayer().then((video) => {
 // 设置事件回调
 SetCallBack(videoPlayer);
 
-// 用户选择视频设置url
-videoPlayer.url = 'file:///data/data/ohos.xxx.xxx/files/test.mp4';
+// 用户选择视频设置fd(本地播放)
+let fdPath = 'fd://'
+let path = 'data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp4';
+await fileIO.open(path).then(fdNumber) => {
+   fdPath = fdPath + '' + fdNumber;
+   console.info('open fd sucess fd is' + fdPath);
+}, (err) => {
+   console.info('open fd failed err is' + err);
+}),catch((err) => {
+   console.info('open fd failed err is' + err);
+});
 
-// 该处需要调用Xcomponent的接口用于获取surfaceID，并保存在surfaceID变量中
+videoPlayer.url = fdPath;
 
 // 设置surfaceID用于显示视频画面
 await videoPlayer.setDisplaySurface(surfaceID).then(() => {
@@ -285,7 +341,19 @@ await videoPlayer.reset().then(() => {
     console.info('reset success');
 }, failureCallback).catch(catchCallback);
 
-videoPlayer.url = 'file:///data/data/ohos.xxx.xxx/files/next.mp4';
+// 用户选择视频设置fd(本地播放)
+let fdNextPath = 'fd://'
+let nextPath = 'data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/02.mp4';
+await fileIO.open(nextPath).then(fdNumber) => {
+   fdNextPath = fdNextPath + '' + fdNumber;
+   console.info('open fd sucess fd is' + fdNextPath);
+}, (err) => {
+   console.info('open fd failed err is' + err);
+}),catch((err) => {
+   console.info('open fd failed err is' + err);
+});
+
+videoPlayer.url = fdNextPath;
 
 // 设置surfaceID用于显示视频画面
 await videoPlayer.setDisplaySurface(surfaceID).then(() => {
@@ -306,9 +374,18 @@ await videoPlayer.play().then(() => {
 ### 单个视频循环场景
 
 ```js
+import media from '@ohos.multimedia.media'
+import fileIO from '@ohos.fileio'
+
 let videoPlayer = undefined; // 用于保存createVideoPlayer创建的对象
 let surfaceID = undefined; // 用于保存Xcomponent接口返回的surfaceID
 
+// 调用Xcomponent的接口用于获取surfaceID，并保存在surfaceID变量中，该接口由XComponent组件默认加载，非主动调用
+LoadXcomponent() {
+	surfaceID = this.$element('Xcomponent').getXComponentSurfaceId();
+    console.info('LoadXcomponent surfaceID is' + surfaceID);
+}
+
 // 函数调用发生错误时用于上报错误信息
 function failureCallback(error) {
     console.info(`error happened,error Name is ${error.name}`);
@@ -350,10 +427,19 @@ await media.createVideoPlayer().then((video) => {
 // 设置事件回调
 SetCallBack(videoPlayer);
 
-// 用户选择视频设置url
-videoPlayer.url = 'file:///data/data/ohos.xxx.xxx/files/test.mp4';
+// 用户选择视频设置fd(本地播放)
+let fdPath = 'fd://'
+let path = 'data/accounts/account_0/appdata/ohos.xxx.xxx.xxx/01.mp4';
+await fileIO.open(path).then(fdNumber) => {
+   fdPath = fdPath + '' + fdNumber;
+   console.info('open fd sucess fd is' + fdPath);
+}, (err) => {
+   console.info('open fd failed err is' + err);
+}),catch((err) => {
+   console.info('open fd failed err is' + err);
+});
 
-// 该处需要调用Xcomponent的接口用于获取surfaceID，并保存在surfaceID变量中
+videoPlayer.url = fdPath;
 
 // 设置surfaceID用于显示视频画面
 await videoPlayer.setDisplaySurface(surfaceID).then(() => {
@@ -372,4 +458,17 @@ videoPlayer.loop = true;
 await videoPlayer.play().then(() => {
     console.info('play success');
 }, failureCallback).catch(catchCallback);
-```
\ No newline at end of file
+```
+
+### Xcomponent创建方法
+
+播放视频中获取surfaceID依赖了Xcomponent,需要创建一个和xxx.js同名的xxx.hml文件,xxx.hml里面需要添加如下代码：
+
+```js
+<xcomponent id = 'Xcomponent'
+	  if = "{{isFlush}}" // 刷新surfaceID，isFlush赋值false再赋值true为一次刷新，会主动再次加载LoadXcomponet获取新的surfaceID
+      type = 'surface'
+	  onload = 'LoadXcomponet' // 默认加载接口
+      style = "wodth:720px;height:480px;border-color:red;border-width:5px;"> // 设置窗口宽高等属性
+</xcomponent>
+```

zh-cn/application-dev/media/video-recorder.md

@@ -23,6 +23,36 @@
 包含流程：创建实例，设置录制参数，录制视频，暂停录制，恢复录制，停止录制，释放资源等流程。
 
 ```js
+import media from '@ohos.multimedia.media'
+import mediaLibrary from '@ohos.multimedia.mediaLibrary'
+
+let testFdNumber;
+
+// pathName是传入的录制文件名，例如：01.mp4，生成后的文件地址：/storage/media/100/local/files/Movies/01.mp4
+// 使用mediaLibrary需要添加以下权限, ohos.permission.MEDIA_LOCATION、ohos.permission.WRITE_MEDIA、ohos.permission.READ_MEDIA
+async function getFd(pathName) {
+    let displayName = pathName;
+    const mediaTest = mediaLibrary.getMediaLibrary();
+    let fileKeyObj = mediaLibrary.FileKey;
+    let mediaType = mediaLibrary.MediaType.VIDEO;
+    let publicPath = await mediaTest.getPublicDirectory(mediaLibrary.DirectoryType.DIR_VIDEO);
+    let dataUri = await mediaTest.createAsset(mediaType, displayName, publicPath);
+    if (dataUri != undefined) {
+        let args = dataUri.id.toString();
+        let fetchOp = {
+            selections : fileKeyObj.ID + "=?",
+            selectionArgs : [args],
+        }
+        let fetchFileResult = await mediaTest.getFileAssets(fetchOp);
+        let fileAsset = await fetchFileResult.getAllObject();
+        let fdNumber = await fileAsset[0].open('Rw');
+        fdNumber = "fd://" + fdNumber.toString();
+        testFdNumber = fdNumber;
+    }
+}
+
+await getFd('01.mp4');
+
 let videoProfile = {
     audioBitrate : 48000,
     audioChannels : 2,
@@ -40,7 +70,7 @@ let videoConfig = {
     audioSourceType : 1,
     videoSourceType : 0,
     profile : videoProfile,
-    url : 'file:///data/media/01.mp4',
+    url : testFdNumber, // testFdNumber由getFd生成
     orientationHint : 0,
     location : { latitude : 30, longitude : 130 },
 }
@@ -61,6 +91,7 @@ function catchCallback(error) {
 	
 let videoRecorder = null; // videoRecorder空对象在createVideoRecorder成功后赋值
 let surfaceID = null; // 用于保存getInputSurface返回的surfaceID
+
 // 创建videoRecorder对象
 await media.createVideoRecorder().then((recorder) => {
     console.info('case createVideoRecorder called');