Intelligent Media Services

https://help.aliyun.com/zh/ims/
Admin
Intelligent Media Services (IMS) is an all-in-one platform for media collection, asset management,...
Tokens:2,310,931
Snippets:11,693
Trust Score:10
Update:1 day ago
Show doc for...
Tokens:
Raw
### Initialize the Web SDK with example API implementations

Source: https://help.aliyun.com/zh/ims/developer-reference/access-the-basic-web-sdk-for-vocal-cloning

Example code showing how to initialize the SDK using window.AliyunTTSFactory.init with a container and API callbacks. The callbacks demonstrate how to call backend APIs for creating a voice ID, fetching recorder lists, uploading/validating/submitting recordings, and customizing copywriting.

```javascript
const ttsFactory = window.AliyunTTSFactory.init({
    container: container,
    api: {
      createVoiceId: async (params) => {
        const res = await request('CreateCustomizedVoiceJob', {
          VoiceName: params.voiceName,
          VoiceId: params.voiceId,
          Gender: params.gender,
          Scenario: params.scenario,
        });
        return {
          success: get(res, 'data.Success', false),
          data: {
            voiceId: get(res, 'data.Data.VoiceId', ''),
          },
        };
      },
      getRecorderList: async (params) => {
        const res = await requestGet('GetDemonstrationForCustomizedVoiceJob', {
          Scenario: params.scenario,
        });
        return {
          success: get(res, 'data.Success', false),
          data: get(res, 'data.Data.DemonstrationList', []).map((item) => {
            return {
              audioId: item.AudioId,
              audioUrl: item.DemoAudio,
              text: item.Text,
            };
          }),
        };
      },
      uploadRecord: async (params) => {
        const fileName = `${params.voiceId}-${
              params.index
            }-${Date.now()}.wav`;
        const result = await uploadFile(fileName,params.file);
        console.log('uploadRecord', params,fileName,result);
        return { success: true, data: { fileUrl: result.url } }
      },
      validRecord: async (params) => {
        const res = await request('DetectAudioForCustomizedVoiceJob', {
          VoiceId: params.voiceId,
          RecordUrl: params.uploadData.fileUrl,
          AudioRecordId: params.index + 1,
        });
        return {
          success:  get(res, 'data.Success', false),
            data: {
              pass:  get(res, 'data.Data.Pass', false),
              reason: get(res, 'data.Data.Reason', ''),
            },
        };
      },
      submitRecord: async (params) => {
        const res = await request('SubmitCustomizedVoiceJob', {
          VoiceId: params.voiceId,
          // DemoAudioMediaURL: '', 人声克隆输出demo音频的地址
        });
        return {
          success: get(res, 'data.Success', false),
        };
      },
      getCopywriting:  (config)=>{
        // 文案修改示例
        console.log('>>config', config);
        config.views.Tutorial.startBtn = '开始'
        return config;
      }
    },
  });
```

--------------------------------

### getCurrentEncoderManufacturer

Source: https://help.aliyun.com/zh/ims/developer-reference/harmony-alirtcengine-interface

Gets the current encoder type. If streaming has not started, returns an invalid type.

```APIDOC
## getCurrentEncoderManufacturer

### Description
Gets the current encoder type. If streaming has not started, returns an invalid type.

### Method
public getCurrentEncoderManufacturer(track: AliRtcVideoTrack): AliRtcVideoCodecManufacturer

### Parameters
- **track** (AliRtcVideoTrack) - Required - Video track.

### Returns
AliRtcVideoCodecManufacturer - Encoder type.
```

--------------------------------

### InputConfig JSON example

Source: https://help.aliyun.com/zh/ims/use-cases/scripted-auto-slice

Shows the JSON structure for InputConfig, including MediaGroupArray with groups 'start', 'middle', 'end' and their media URLs, SpeechTextArray with two speech texts, and TitleArray with three titles.

```json
{
  "MediaGroupArray": [{
    "GroupName": "start",
    "MediaArray": [
      "http://ice-document-materials.oss-cn-shanghai.aliyuncs.com/test_media/lgh/lgh-start-1.mp4"
    ]
  },
    {
      "GroupName": "middle",
      "MediaArray": [
        "http://ice-document-materials.oss-cn-shanghai.aliyuncs.com/test_media/lgh/lgh-m-1.mp4",
        "http://ice-document-materials.oss-cn-shanghai.aliyuncs.com/test_media/lgh/lgh-m-2.mp4",
        "http://ice-document-materials.oss-cn-shanghai.aliyuncs.com/test_media/lgh/lgh-m-3.mp4"
      ]
    },
    {
      "GroupName": "end",
      "MediaArray": [
        "http://ice-document-materials.oss-cn-shanghai.aliyuncs.com/test_media/lgh/lgh-end-1.mp4"
      ]
    }
  ],
  "SpeechTextArray": [
    "假期纠结去哪儿玩？云南泸沽湖邀您共赴一场与自然的约会。湛蓝湖水如镜，映照着摩梭女儿国的独特风情，如诗如画。泛舟湖心，感受猪槽船摇曳的岁月静好；仰望XX山，****神秘的故事传说。还在等什么，快来泸沽湖共享这一份静谧而迷人的湖光山色吧！",
    "假期规划还在犹豫不决？何不考虑赴一场云南泸沽湖的自然盛宴。那湛蓝如镜的湖面，映射出摩梭女儿国独特的民俗风情，如诗如画，引人入胜。您可在湖心悠然泛舟，体验猪槽船摇曳间的宁静岁月；也可抬头瞻仰神圣XX山，倾听那穿越千年的古老神秘传说。快来泸沽湖，共享这片静谧而迷人的湖光山色所带来的无尽诗意吧！"
  ],
  "TitleArray": [
    "泸沽湖：湖光山色中的摩梭风情",
    "探寻秘境泸沽湖",
    "沉浸式体验泸沽湖"
  ]
}
```

--------------------------------

### quick.html - RTC SDK quick start HTML

Source: https://help.aliyun.com/zh/ims/developer-reference/quick-use

HTML file for the quick start demo. Includes Bootstrap and jQuery from CDN, the Aliyun RTC SDK script, and a form for channel ID and user ID. Contains local preview and remote video container.

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>aliyun-rtc-sdk quick start</title>
    <link rel="stylesheet" href="https://g.alicdn.com/code/lib/bootstrap/5.3.0/css/bootstrap.min.css" />
    <style>
      .video {
        display: inline-block;
        width: 320px;
        height: 180px;
        margin-right: 8px;
        margin-bottom: 8px;
        background-color: black;
      }
    </style>
  </head>
  <body class="container p-2">
    <h1>aliyun-rtc-sdk 快速开始</h1>
    <div class="toast-container position-fixed top-0 end-0 p-3">
      <div id="loginToast" class="toast" role="alert" aria-live="assertive" aria-atomic="true">
        <div class="toast-header">
          <strong class="me-auto">登录消息</strong>
          <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
        </div>
        <div class="toast-body" id="loginToastBody"></div>
      </div>
      <div id="onlineToast" class="toast" role="alert" aria-live="assertive" aria-atomic="true">
        <div class="toast-header">
          <strong class="me-auto">用户上线</strong>
          <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
        </div>
        <div class="toast-body" id="onlineToastBody"></div>
      </div>
      <div id="offlineToast" class="toast" role="alert" aria-live="assertive" aria-atomic="true">
        <div class="toast-header">
          <strong class="me-auto">用户下线</strong>
          <button type="button" class="btn-close" data-bs-dismiss="toast" aria-label="Close"></button>
        </div>
        <div class="toast-body" id="offlineToastBody"></div>
      </div>
    </div>
    <div class="row mt-3">
      <div class="col-6">
        <form id="loginForm">
          <div class="form-group mb-2">
            <label for="channelId" class="form-label">频道号</label>
            <input class="form-control" id="channelId" />
          </div>
          <div class="form-group mb-2">
            <label for="userId" class="form-label">用户ID</label>
            <input class="form-control" id="userId" />
          </div>
          <button id="joinBtn" type="submit" class="btn btn-primary mb-2">加入频道</button>
          <button id="leaveBtn" type="button" class="btn btn-secondary mb-2" disabled>离开频道</button>
        </form>
        <div class="mt-3">
          <h4>本地预览</h4>
          <video
            id="localPreviewer"
            muted
            class="video"
          ></video>
        </div>
      </div>
      <div class="col-6">
        <h4>远端用户</h4>
        <div id="remoteVideoContainer"></div>
      </div>
    </div>
    <script src="https://g.alicdn.com/code/lib/jquery/3.7.1/jquery.min.js"></script>
    <script src="https://g.alicdn.com/code/lib/bootstrap/5.3.0/js/bootstrap.min.js"></script>
<script src="https://g.alicdn.com/apsara-media-box/imp-web-rtc/7.3.4/aliyun-rtc-sdk.js"></script>
    <script src="./quick.js"></script>
  </body>
</html>
```

--------------------------------

### Create demo directory structure

Source: https://help.aliyun.com/zh/ims/developer-reference/quick-use

Shows the required file structure for the demo: a demo folder containing quick.html and quick.js.

```plaintext
- demo
  - quick.html
  - quick.js
```

--------------------------------

### Java IMS SDK: Get, Submit, and Get Live Editing Jobs

Source: https://help.aliyun.com/zh/ims/developer-reference/clip-composition

This snippet contains three sequential Java examples using the IMS SDK. The first retrieves a single media producing job by ID. The second submits a live editing job with live stream clips, specifying clips, project ID, live stream config, output media config, media produce config, user data, and output target. The third retrieves a live editing job by ID. The examples show how to set request parameters and print job IDs and statuses.

```java
// 获取单个合成任务
GetMediaProducingJobRequest request = new GetMediaProducingJobRequest();
request.setJobId("****67f44f4964e6c998dee8****");
GetMediaProducingJobResponse reqponse = client.getMediaProducingJob(request);
System.out.println("jobId : " + reqponse.getBody().getMediaProducingJob().getJobId());
System.out.println("status : " + reqponse.getBody().getMediaProducingJob().getStatus());

// 通过直播流区间提交合成
SubmitLiveEditingJobRequest submitLiveEditingJobRequest = new SubmitLiveEditingJobRequest();
submitLiveEditingJobRequest.setClips("[{\"StartTime\":\"2021-06-21T08:01:00Z\",\"EndTime\":\"2021-06-21T08:03:00Z\",\"AppName\":\"app\",\"DomainName\":\"domain.com\",\"StreamName\":\"stream\"},{\"StartTime\":\"2021-06-21T08:05:00Z\",\"EndTime\":\"2021-06-21T08:09:00Z\"}]");
submitLiveEditingJobRequest.setProjectId("****fddd7748b58bf1d47e95****");
submitLiveEditingJobRequest.setLiveStreamConfig("{ \"AppName\": \"app\", \"DomainName\": \"domain.com\", \"StreamName\": \"stream\" }");
submitLiveEditingJobRequest.setOutputMediaConfig("{ \"MediaURL\": \"https://example-bucket.oss-cn-shanghai.aliyuncs.com/testfile.mp4\" }");
submitLiveEditingJobRequest.setMediaProduceConfig("{ \"Mode\": \"AccurateFast\"}");
submitLiveEditingJobRequest.setUserData("{\"key\": \"value\"}");
submitLiveEditingJobRequest.setOutputMediaTarget("oss-object");
SubmitLiveEditingJobResponse submitLiveEditingJobResponse = client.submitLiveEditingJob(submitLiveEditingJobRequest);
System.out.println("jobId:"+submitLiveEditingJobResponse.getBody().getJobId());
System.out.println("requestid:"+submitLiveEditingJobResponse.getBody().getRequestId());

// 通过直播JobId获取单个信息
GetLiveEditingJobRequest getLiveEditingJobRequest = new GetLiveEditingJobRequest();
getLiveEditingJobRequest.setJobId("****d80e4e4044975745c14b****");
GetLiveEditingJobResponse getLiveEditingJobResponse = client.getLiveEditingJob(getLiveEditingJobRequest);
System.out.println("state:"+getLiveEditingJobResponse.getBody().getLiveEditingJob().getStatus());

}
```

--------------------------------

### Web: Enable and use push-to-talk mode with AICallKit

Source: https://help.aliyun.com/zh/ims/user-guide/intercom-mode

JavaScript example for Web. Enable push-to-talk by calling enablePushToTalk(enable), then use startPushToTalk on button press, finishPushToTalk on release, and cancelPushToTalk to cancel. Listen to the 'pushToTalkChanged' event to get the final enabled state.

```javascript
// 默认情况下是关闭对讲机模式，传入true开启对讲机模式
engine.enablePushToTalk(enable);

// 按住开始讲话
engine.startPushToTalk();

// 松开完成此轮次讲话
engine.finishPushToTalk();

// 松开取消此次讲话
engine.cancelPushToTalk();

engine.on('pushToTalkChanged', (enable) => {
  // 当前通话的对讲机模式是否启用回调
  // 最终是否开启/关闭，以该回调为准
  console.log('AICallPushToTalk', enable);
});
```

--------------------------------

### Complete Preview Player Example

Source: https://help.aliyun.com/zh/ims/developer-reference/access-the-preview-component-web-sdk

A complete HTML example that creates a preview player with a timeline including custom fonts, transitions, effects, and editable subtitles. Includes the player container, subtitle editing controls, and the timeline configuration with video, image, transition, and VFX clips.

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <link
      rel="stylesheet"
      href="https://g.alicdn.com/thor-server/video-editing-websdk/5.2.2/player.css"
    />
    <script src="https://g.alicdn.com/thor-server/video-editing-websdk/5.2.2/player.js"></script>
    <title>云剪预览播放器</title>
  </head>
  <body>
    <div id="root" style="width: 820px;margin: 30px auto;" >
      <div id="player" style="width: 800px; height: 450px"></div>
      <div style="margin-top: 16px">
        <div>
          <label>ID</label>   <br/>
          <input id="subtitle" value="123" />
          <br/>
          <label>内容</label>   <br/>
          <textarea id="content"  rows="4" >自定义编辑字幕</textarea>
        </div>
        <button id="addSubtitle">添加字幕</button>
        <button id="updateSubtitle">修改字幕</button>
        <button id="moveSubtitle">移动字幕</button>
        <button id="removeSubtitle">删除字幕</button>
      </div>
    </div>
    <script type="text/javascript">
      const timelineDemo = {
        Version: 1,
        SdkVersion: "4.12.2",
        VideoTracks: [
          {
            // 视频轨道
            Id: 1,
            Type: "Video",
            Visible: true,
            Disabled: false,
            Count: 1,
            VideoTrackClips: [
              {
                // 图片
                Id: 3,
                TrackId: 1,
                Type: "Image",
                MediaURL:
                  "https://img.alicdn.com/imgextra/i4/O1CN01TDN7Gw1SCgVv61T4s_!!6000000002211-0-tps-1920-1046.jpg",
                Title: "test.png",
                X: 0,
                Y: 0,
                Width: 1,
                Height: 1,
                TimelineIn: 0,
                TimelineOut: 5,
                Duration: 5,
                VirginDuration: 5,
              },
              {
                // 视频
                Id: 4,
                TrackId: 1,
                Type: "Video",
                MediaURL:
                  "https://ice-pub-media.myalicdn.com/vod-demo/%E6%9C%80%E7%BE%8E%E4%B8%AD%E5%9B%BD%E7%BA%AA%E5%BD%95%E7%89%87-%E6%99%BA%E8%83%BD%E5%AD%97%E5%B9%95.mp4",
                X: 0,
                Y: 0,
                Width: 1,
                Height: 1,
                TimelineIn: 4, // 转场的入点(TimelineIn)需要在上一个片段出点(TimelineOut)以前
                TimelineOut: 9,
                Duration: 5,
                VirginDuration: 5,
                Effects: [
                  {
                    // 转场
                    Type: "Transition",
                    Id: 13,
                    Name: "transitions.directional",
                    SubType: "directional",
                    Duration: 1, // 转场时长=上一个片段出点(TimelineOut)-这个片段的入点(TimelineIn)
                    From: 3, // 上一个片段的ID
                  },
                ],
              },
            ],
          },
          {
            // 特效轨道
            Id: 2,
            Type: "Effect",
            Visible: true,
            Disabled: false,
            Count: 1,
            VideoTrackClips: [
              {
                Type: "VFX",
                Id: 2,
                TrackId: 1,
                SubType: "heartfireworks",
                TimelineIn: 0,
                TimelineOut: 5,
                Duration: 5,
                X: 0,
                Y: 0,
                Width: 0,
                Height: 0,
              },
            ],
          },
        ],
        AudioTracks: [],
        SubtitleTracks: [
          {
            Id: 2,
            Type: "Text",
            Visible: true,
            Disabled: false,
            Count: 1,
            SubtitleTrackClips: [
              {
                Id: 1,
                TrackId: 2,
                Type: "Text",
                X: 0,

```

--------------------------------

### Launch AI call via AUIAICallEntranceActivity

Source: https://help.aliyun.com/zh/ims/user-guide/android-use-guide-1

Use this code to start an AI call from your app. Ensure microphone and camera permissions are granted before launching. Set the agent type, agent ID, region, user ID, and authentication token. The token must be generated as described in the ARTC authentication token guide.

```java
/** 启动之前保证麦克风、摄像头权限已授权 */
Context currentActivity = AUIAICallEntranceActivity.this;
Intent intent = new Intent(currentActivity, AUIAICallInCallActivity.class);

// 设置通话的类型（语音、数字人或视觉理解），需要与AgentId的类型对应
ARTCAICallEngine.ARTCAICallAgentType aiCallAgentType = 
    ARTCAICallEngine.ARTCAICallAgentType.VoiceAgent;
// 智能体ID, 不能为nil
String aiAgentId = "";
// 智能体所在的区域，不能为nil
String aiAgentRegion = "";
// 进入rtc的用户id，建议使用业务的登录用户id
String userId = "123";
// 通话鉴权Token，参考：https://help.aliyun.com/zh/ims/user-guide/generate-artc-authentication-token?spm=a2c4g.11186623.0.0.1ce65bc4BKdQy7
String token = "";

intent.putExtra(AUIAIConstStrKey.BUNDLE_KEY_LOGIN_USER_ID, userId);
// 智能体类型
intent.putExtra(AUIAIConstStrKey.BUNDLE_KEY_AI_AGENT_TYPE, aiCallAgentType);
// 智能体ID
intent.putExtra(AUIAIConstStrKey.BUNDLE_KEY_AI_AGENT_ID, aiAgentId);
//智能体所在区域
intent.putExtra(AUIAIConstStrKey.BUNDLE_KEY_AI_AGENT_REGION, aiAgentRegion);
//设置通话鉴权Token
intent.putExtra(AUIAIConstStrKey.BUNDLE_KEY_RTC_AUTH_TOKEN, token);

currentActivity.startActivity(intent);
```

--------------------------------

### init

Source: https://help.aliyun.com/zh/ims/user-guide/api-interface-details-1

Initializes the ARTCAICallEngine with the provided configuration.

```APIDOC
## init

### Description
Initializes the ARTCAICallEngine with the provided configuration.

### Method
init

### Signature
public abstract void init(ARTCAICallConfig config);

### Parameters
- **config** (ARTCAICallConfig) - Required - Initialization configuration.

### Request Example
```java
ARTCAICallConfig config = new ARTCAICallConfig();
engine.init(config);
```

### Response
No return value.
```

--------------------------------

### Build demo with CMake

Source: https://help.aliyun.com/zh/ims/developer-reference/artc-sdk-for-linux-c-fast-access

Run these commands in the Demo directory to build the project. The executable linux_sdk_simple_demo will be generated in the build directory.

```bash
mkdir build
cd build
cmake ..
make
```

--------------------------------

### Basic Web SDK for Vocal Cloning - Full HTML Example

Source: https://help.aliyun.com/zh/ims/developer-reference/access-the-basic-web-sdk-for-vocal-cloning

Complete HTML page that loads required scripts (lodash, OSS SDK, TTS Factory SDK) and initializes the AliyunTTSFactory with API callbacks. Includes helper functions for API requests, STS refresh, and OSS upload. Use this as a starting point for integrating vocal cloning in a web page.

```html
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <link rel="icon" type="image/svg+xml" href="/vite.svg" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <script src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.21/lodash.min.js"></script>
  <script src="http://gosspublic.alicdn.com/aliyun-oss-sdk-6.19.0.min.js"></script>
  <script src="https://g.alicdn.com/video-cloud-fe/tts-factory/0.0.2/index.js"></script>
  <title>ALI TTS DEMO</title>
</head>
<body>
  <div id="app"></div>
  <script>
    async function request(action, params) {
      const res = await fetch('/openApiPost', {
        method: 'POST', body: JSON.stringify({...params, Action: action}), headers: {
          'Content-Type': 'application/json; charset=utf-8'
        }
      })
      const data = await res.json();
      return {data};
    }
    async function requestGet(action, params) {
      const searchParams = new URLSearchParams();
      searchParams.set('Action', action);
      Object.keys(params).forEach((key) => {
        searchParams.set(key, params[key]);
      });
      const res = await fetch(`/openApi?${ searchParams.toString() }`, {method: 'GET'})
      const data = await res.json();
      return {data};
    }
    const refreshSts = async () => {
      // 创建上传到oss的sts，参考文档 https://help.aliyun.com/zh/oss/developer-reference/authorize-access-6?spm=a2c4g.11186623.0.i6#section-iy3-bfe-7mn
      const res = await fetch("/createSTS", {method: 'POST'});
      const data = await res.json();
      return data.data;
    }
    const uploadFile = async (fileName,file) => {
      // 上传oss 参考文档 https://help.aliyun.com/zh/oss/developer-reference/simple-upload-8?spm=a2c4g.11186623.0.0.27d22dc50M8glG
      const sts = await refreshSts();
      const client = new OSS({
        // yourRegion填写Bucket所在地域。以华东1（杭州）为例，yourRegion填写为oss-cn-hangzhou。
        region: `oss-${ sts.region }`,
        accessKeyId: sts.accessKeyId,
        accessKeySecret: sts.accessKeySecret,
        stsToken: sts.securityToken,
        // 填写Bucket名称。
        bucket: sts.bucket,
        // 刷新临时访问凭证。
        refreshSTSToken: async () => {
          const refreshToken = await refreshSts();
          return {
            accessKeyId: refreshToken.accessKeyId,
            accessKeySecret: refreshToken.accessKeySecret,
            stsToken: refreshToken.securityToken,
          };
        },
      });
      const result = await client.multipartUpload(fileName, file, {
        progress: (p, _cpt, res) => {
          console.log('res', res);
        },
        parallel: 2,
        partsize: 1024 * 512,
      });
      const url = new URL(result.res.requestUrls[0]);
      return {url: `${ url.origin }${ url.pathname }`}
    }
    const get = _.get;
    const container = document.getElementById('app');
    const ttsFactory = window.AliyunTTSFactory.init({
      container: container,
      api: {
        createVoiceId: async (params) => {
          const res = await request('CreateCustomizedVoiceJob', {
            VoiceName: params.voiceName,
            VoiceId: params.voiceId,
            Gender: params.gender,
            Scenario: params.scenario,
          });
          return {
            success: get(res, 'data.Success', false),
            data: {
              voiceId: get(res, 'data.Data.VoiceId', ''),
            },
          };
        },
        getRecorderList: async (params) => {
          const res = await requestGet('GetDemonstrationForCustomizedVoiceJob', {
            Scenario: params.scenario,
          });
          return {
            success: get(res, 'data.Success', false),
            data: get(res, 'data.Data.DemonstrationList', []).map((item) => {
              return {
                audioId: item.AudioId,
                audioUrl: item.DemoAudio,
                text: item.Text,
              };
            }),
          };
        },
        uploadRecord: async (params) => {
          const fileName = `${params.voiceId}-${
                params.index
              }-${Date.now()}.wav`;
          const result = await uploadFile(fileName,params.file);
          console.log('uploadRecord', params,fileName,result);
          return { success: true, data: { fileUrl: result.url } }
        },
        validRecord: async (params) => {
          const res = await request('DetectAudioForCustomizedVoiceJob', {
            VoiceId: params.voiceId,
            RecordUrl: params.uploadData.fileUrl,
            AudioRecordId: params.index + 1,
          });
          return {
            success:  get(res, 'data.Success', false),
              data: {
                pass:  get(res, 'data.Data.Pass', false),
                reason: get(res, 'data.Data.Reason', ''),
              },
          };
        },
        submitRecord: async (params) => {
          const res = await request('SubmitCustomizedVoiceJob', {
            VoiceId: params.voiceId,

```

--------------------------------

### init() 初始化配置示例

Source: https://help.aliyun.com/zh/ims/developer-reference/access-the-video-clip-web-sdk

配置 AliyunVideoEditor.init() 方法，包含容器、语言、license、动态媒资获取、工程素材管理、素材搜索、删除素材、贴纸分类和列表获取等回调。注意 Web SDK 不提供 request 方法，需自行实现请求逻辑。

```javascript
// 注意，WebSDK 本身并不提供 request 这个方法，这里仅作为示例，您可以使用您喜欢的网络请求库，如 axios 等

window.AliyunVideoEditor.init({
  container: document.getElementById('aliyun-video-editor'),
  locale: 'zh-CN',
  licenseConfig: {
     rootDomain: "", // license使用的根域名，例如abc.com
     licenseKey: "", // 申请的licenseKey，没有配置licenseKey，在预览时会出现水印,没有配置license的情况下，只能在localhost的域名下预览
  },
  useDynamicSrc: true, // 媒资库默认情况下播放地址会过期，所以需要动态获取
  getDynamicSrc: (mediaId, mediaType) => new Promise((resolve, reject) => {
    request('GetMediaInfo', { // https://help.aliyun.com/document_detail/197842.html
      MediaId: mediaId
    }).then((res) => {
      if (res.code === '200') {
        // 注意，这里仅作为示例，实际中建议做好错误处理，避免如 FileInfoList 为空数组时报错等异常情况
        resolve(res.data.MediaInfo.FileInfoList[0].FileBasicInfo.FileUrl);
      } else {
        reject();
      }
    });
  }),
  getEditingProjectMaterials: () => {
    if (projectId) { // 如果没有 projectId，需要先在智能媒体服务控制台创建剪辑工程，获取projectId。
      return request('GetEditingProjectMaterials', { // https://help.aliyun.com/document_detail/209068.html
        ProjectId: projectId
      }).then((res) => {
        const data = res.data.MediaInfos;
        return transMediaList(data); // 需要做一些数据变换，具体参考后文
      });
    }
    return Promise.resolve([]);
  },
  searchMedia: (mediaType) => { // mediaType 为用户当前所在的素材 tab，可能为 video | audio | image，您可以根据这个参数对应地展示同类型的可添加素材
    return new Promise((resolve) => {
      // 调用方需要自己实现展示媒资、选择媒资添加的界面，这里的 callDialog 只是一种示例，WebSDK 本身并不提供
      // 关于展示媒资，请参考：https://help.aliyun.com/document_detail/197964.html
      callDialog({
        onSubmit: async (materials) => {
          if (!projectId) { // 如果没有 projectId，需要先创建工程，如果能确保有 projectId，则不需要该步
            const addRes = await request('CreateEditingProject', { // https://help.aliyun.com/document_detail/197834.html
              Title: 'xxxx',
            });
            projectId = addRes.data.Project.ProjectId;
          }

          // 组装数据
          const valueObj = {};
          materials.forEach(({ mediaType, mediaId }) => {
            if (!valueObj[mediaType]) {
              valueObj[mediaType] = mediaId;
            } else {
              valueObj[mediaType] += mediaId;
            }
          })
          const res = await request('AddEditingProjectMaterials', { // https://help.aliyun.com/document_detail/209069.html
            ProjectId: projectId,
            MaterialMaps: valueObj,
          });
          if (res.code === '200') {
            return resolve(transMediaList(res.data.MediaInfos));
          }
          resolve([]);
        }
      });
    });
  },
  deleteEditingProjectMaterials: async (mediaId, mediaType) => {
    const res = await request('DeleteEditingProjectMaterials', { // https://help.aliyun.com/document_detail/209067.html
      ProjectId: projectId,
      MaterialType: mediaType,
      MaterialIds: mediaId
    });
    if (res.code === '200') return Promise.resolve();
    return Promise.reject();
  },
  getStickerCategories: async () => {
    const res = await request('ListAllPublicMediaTags', { // https://help.aliyun.com/document_detail/207796.html
      BusinessType: 'sticker',
      WebSdkVersion: window.AliyunVideoEditor.version
    });

    const stickerCategories = res.data.MediaTagList.map(item => ({
      id: item.MediaTagId,
      name: myLocale === 'zh-CN' ? item.MediaTagNameChinese : item.MediaTagNameEnglish // myLocale 是您期望的语言
    }));
    return stickerCategories;
  },
  getStickers: async ({ categoryId, page, size }) => {
    const params = {
      PageNo: page,
      PageSize: size,
      IncludeFileBasicInfo: true,
      MediaTagId: categoryId
    };

    const res = await request('ListPublicMediaBasicInfos', params); // https://help.aliyun.com/document_detail/207797.html

    const fileList = res.data.MediaInfos.map(item => ({
      mediaId: item.MediaId,
      src: item.FileInfoList[0].FileBasicInfo.FileUrl
    }));

    return fileList;
  }
});
```

--------------------------------

### w tag example

Source: https://help.aliyun.com/zh/ims/developer-reference/ssml-markup-language-description

Example of using the <w> tag to mark a word in a sentence.

```xml
 <speak>南京市长<w>江大桥</w>今天发表了演讲。</speak>
```

--------------------------------

### sub tag example

Source: https://help.aliyun.com/zh/ims/developer-reference/ssml-markup-language-description

Example of using the <sub> tag to replace 'W3C' with '网络协议标准'.

```xml
 <speak><sub alias="网络协议标准">W3C</sub></speak>
```

--------------------------------

### startPreview

Source: https://help.aliyun.com/zh/ims/developer-reference/android-alirtcengine-class

Starts local preview and automatically opens the camera. Must set a local view via setLocalViewConfig before calling, otherwise preview will not work but pushing stream is unaffected. Can be called before joining the channel.

```APIDOC
## startPreview

### Description
Starts local preview and automatically opens the camera. Must set a local view via setLocalViewConfig before calling, otherwise preview will not work but pushing stream is unaffected. Can be called before joining the channel.

### Method
public abstract int startPreview()

### Return
0 indicates success, other values indicate failure.
```

--------------------------------

### 推送音视频流（startScreenShare）

Source: https://help.aliyun.com/zh/ims/developer-reference/custom-input

调用AliRtcEngine实例的startScreenShare方法，将获取到的视频流和音频流推送给远端用户。成功时输出'自定义流推送成功'，失败时输出'自定义流推送失败'。注意屏幕共享流和自定义流是互斥的，同一个实例无法同时推送。

```javascript
instance.startScreenShare({
  videoTrack,
  audioTrack,
}).then(() => {
  console.log('自定义流推送成功');
}).catch(() => {
  console.err('自定义流推送失败');
});
```

--------------------------------

### s tag example

Source: https://help.aliyun.com/zh/ims/developer-reference/ssml-markup-language-description

Example of using the <s> tag to mark two sentences in a speak element.

```xml
<speak><s>这是第一句话</s><s>这是第二句话</s></speak>
```

--------------------------------

### Example Response (JSON)

Source: https://help.aliyun.com/zh/ims/developer-reference/api-ice-2020-11-09-submitscenemediaselectionjob

A normal response example for SubmitSceneMediaSelectionJob, returning the RequestId and JobId.

```json
{
  "RequestId": "*****ACB-44F2-5F2D-88D7-1283E70*****",
  "JobId": "****20b48fb04483915d4f2cd8ac****"
}
```

--------------------------------

### Create Podfile

Source: https://help.aliyun.com/zh/ims/developer-reference/download-the-sdk

Initializes a Podfile in the project root directory. Run this command in the terminal after navigating to the project root.

```powershell
pod init
```

--------------------------------

### 媒资审核完整流程（Go）

Source: https://help.aliyun.com/zh/ims/developer-reference/media-capital-audit-1

该示例演示了使用Go SDK进行媒资审核的完整流程：创建审核模板（CreateCustomTemplate）、提交媒体审核任务（SubmitMediaCensorJob）、查询任务详情（QueryMediaCensorJobDetail）和查询任务列表（QueryMediaCensorJobList）。代码中使用了环境变量中的AccessKey，并注释了硬编码AccessKey的替代方式（强烈不建议）。

```Go
package main

import (
    "fmt"
    openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
    ice "github.com/alibabacloud-go/ice-20201109/v2/client"
    "github.com/aliyun/credentials-go/credentials"
    "github.com/alibabacloud-go/tea/tea"
)

func main() {

    // 阿里云账号AccessKey拥有所有API的访问权限，建议您使用RAM用户进行API访问或日常运维。
    // 本示例以将AccessKey ID和 AccessKey Secret保存在环境变量为例说明。
    credential, _err := credentials.NewCredential(nil)
    if _err != nil {
      panic(_err)
    }
    iceClient, _err := ice.NewClient(&openapi.Config{
      Credential: credential,
      Endpoint: tea.String("ice.cn-shanghai.aliyuncs.com"),
    })

    // 如需硬编码AccessKey ID和AccessKey Secret，代码如下，强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里，否则可能导致AccessKey泄露，威胁您账号下所有资源的安全。
    // config := new(openapi.Config)
    // config.SetAccessKeyId("<accessKeyId>").
    //     SetAccessKeySecret("<accessKeySecret>").
    //     SetRegionId("<regionId>").
    //     SetEndpoint("<endpoint>")
    // iceClient, _err := ice.NewClient(config)

    if _err != nil {
      panic(_err)
    }

    // 创建审核模板。
    templateName := "sdk_sample_censor_template"
    templateType := int32(7)
    templateSubType := int32(1)
    censorTemplateConfig := "{\"Scene\":[\"porn\",\"terrorism\"],\"Scope\":[\"title\",\"video\",\"audio\",\"cover\"]}"
    createCustomTemplateRequest := &ice.CreateCustomTemplateRequest{
        Name:           &templateName,
        Type:           &templateType,
        Subtype:        &templateSubType,
        TemplateConfig: &censorTemplateConfig,
    }
    createCustomTemplateResponse, err := iceClient.CreateCustomTemplate(createCustomTemplateRequest)
    fmt.Println(createCustomTemplateResponse, err)

    // 提交媒体审核任务。
    templateId := createCustomTemplateResponse.Body.CustomTemplate.TemplateId
    inputType := "Media"
    inputMedia := "3945e42d-1823498****"
    output := "oss://testbucket/censor/snapshot-{Count}.jpg"
    submitMediaCensorJobRequest := &ice.SubmitMediaCensorJobRequest{
        Input: &ice.SubmitMediaCensorJobRequestInput{
            Type:  &inputType,
            Media: &inputMedia,
        },
        Output:     &output,
        TemplateId: templateId,
    }
    submitMediaCensorJobResponse, err := iceClient.SubmitMediaCensorJob(submitMediaCensorJobRequest)
    fmt.Println(submitMediaCensorJobResponse, err)

    // 查询媒体审核任务作业详情。
    jobId := submitMediaCensorJobResponse.Body.JobId
    queryMediaCensorJobDetailRequest := &ice.QueryMediaCensorJobDetailRequest{
        JobId: jobId,
    }
    queryMediaCensorJobDetailResponse, err := iceClient.QueryMediaCensorJobDetail(queryMediaCensorJobDetailRequest)
    fmt.Println(queryMediaCensorJobDetailResponse, err)

    // 查询媒体审核任务作业列表。
    queryMediaCensorJobListRequest := &ice.QueryMediaCensorJobListRequest{
        JobIds: jobId,
    }
    queryMediaCensorJobListResponse, err := iceClient.QueryMediaCensorJobList(queryMediaCensorJobListRequest)
    fmt.Println(queryMediaCensorJobListResponse, err)
}
```
Tokens:
Raw