Enterprise Live Streaming

https://www.volcengine.com/docs/3019
Admin
Enterprise Live Streaming is a comprehensive platform for hosting interactive live broadcasts with...
Tokens:1,419,035
Snippets:6,947
Trust Score:10
Update:9 months ago
Show doc for...
Tokens:
Raw
### Full Example: Independent Player Setup and Event Handling (Objective-C)

Source: https://www.volcengine.com/docs/3019/1206173

This comprehensive example demonstrates the complete setup for an independent player, including joining a live room with specified activity parameters and handling delegate callbacks for stall events. It also includes the logic for leaving the live room.

```objectivec
@interface ViewController () <BDLBasePlayerViewDelegate>
@property (nonatomic, strong) BDLBasePlayerView *playerView;
@end

- (void)joinLiveRoom {    
    BDLActivity *activity = [[BDLActivity alloc] init];
    activity.activityId = @(167808997736****);
    activity.token = @"JQ****";
    activity.isPortrait = YES;
    activity.authMode = BDLActivityAuthModePublic;
    
    [[BDLLiveEngine sharedInstance] joinLiveRoomWithActivity:activity
                                                     success:^{ 
        self.playerView =[[BDLBasePlayerView alloc] init];
        self.playerView.delegate = self;
        [self.view addSubview:self.playerView];
        [self.playerView mas_makeConstraints:^(MASConstraintMaker *make) {
            make.edges.equalTo(self.view);
        }];
    } failure:^(NSError * _Nonnull error) {
        NSLog(@"%@", error.localizedDescription);
    }];
}

- (void)leaveLiveRoom {
    [[BDLLiveEngine sharedInstance] leaveLiveRoom];
    [self.playerView removeFromSuperview];
    self.playerView = nil;
}

- (void)basePlayerViewStallStart:(BDLBasePlayerView *)basePlayerView {
    NSLog(@"%s", __func__);
}

- (void)basePlayerViewStallEnd:(BDLBasePlayerView *)basePlayerView {
    NSLog(@"%s", __func__);
}

objectivec

```

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

### API Request Example

Source: https://www.volcengine.com/docs/3019/100061

An example GET request to the VolcEngine LiveSaaS API to retrieve activity basic configuration. This includes the API endpoint, version, and activity ID.

```http
GET https://livesaas.volcengineapi.com/?Action=GetActivityBasicConfigAPI&Version=2020-06-01&ActivityId=1778****94933
```

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

### Full Example: Initialize and Leave Live Room - Java

Source: https://www.volcengine.com/docs/3019/1253556

This comprehensive Java example shows the complete process of initializing a live room player and subsequently leaving the room. It includes setting up the server, player view, and room parameters before starting and closing the room. This example assumes specific activity IDs, tokens, and uses a public authentication mode.

```Java
long activityId = 1721010849258****;
String token = "pg****";

TVULiveRoomServer mServer = new TVULiveRoomServer(this, activityId, token, TVULiveRoomServer.SERVER_TYPE_PORTRAIT_LIVEROOM);
PlayerView playerView = (PlayerView) LayoutInflater.from(this).inflate(com.bytedance.live.sdk.R.layout.tvu_player_layout, null, false);
mServer.setRoomAuthMode(TVULiveRoom.TVURoomAuthMode.PUBLIC);
mServer.setPlayerView(playerView);
FrameLayout playerViewContainer = findViewById(R.id.player_view_container);
playerViewContainer.addView(playerView, new FrameLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT));
// 启动 TVULiveRoomServer 实例。
mServer.start();
// 离开直播间并销毁完整播放器。
mServer.closeRoom();
```

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

### ListProjects API Request Example (GET)

Source: https://www.volcengine.com/docs/3019/1529688

Demonstrates how to call the ListProjects API using an HTTP GET request. It includes essential parameters like Action, Version, PageNumber, PageSize, and DisplayName for fetching project lists.

```http
GET https://livesaas.volcengineapi.com/?Action=ListProjects&Version=2024-08-01&PageNumber=1&PageSize=10&DisplayName=A
```

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

### Initialize Volcengine Mini Program SDK

Source: https://www.volcengine.com/docs/3019/1155422

In the connection page's `.js` file, import the SDK, and in the `onLoad` method, retrieve necessary parameters (like `activityId`, `userId`, `userName`), obtain an authorization token, and initialize the SDK using `volc.init`. Ensure to handle cases where user information might not be passed directly.

```javascript
import volc from './volc-mini-sdk/index';

Page({
  data: {},
  async onLoad(e) {
    let { activityId, userId, userName } = e;

    if (!userId || !userName) {
      // If userId and userName are not available, define them here
      { userId, userName } = this.getCustomUser(); // You need to implement this method
    }

    // Get authorization token for custom mode (mode=2)
    const token = await this.getMode2token(activityId, userId, userName);

    // Initialize SDK
    await this.initSDK(activityId, token);
  },

  async getMode2token(activityId, userId, userName) {
    // Call GetSDKTokenAPI to get the authorization token
    const token = await GetSDKTokenAPI(activityId, userId, userName);
    return token;
  },

  async initSDK(activityId, token) {
    const res = await volc.init({
      activityId: activityId,
      token: token,
      mode: 2, // Custom mode
      autoConnect: true, // Automatically show voice/video connection options
    });

    if (!res) {
      wx.showToast({
        title: 'Live room information error',
        icon: 'error'
      });
    }
  },

  onUnload() {
    // Destroy the live room when the page unloads
    volc.destroy();
  }
})
```

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

### Get Live Stream Online Number (API Request Example)

Source: https://www.volcengine.com/docs/3019/100072

This example demonstrates how to make a GET request to the GetRealTimeOnlineNumberAPI to retrieve the real-time online user count for a specific live room. It requires the `Action`, `Version`, and `ActivityId` as parameters.

```http
GET https://livesaas.volcengineapi.com/?Action=GetRealTimeOnlineNumberAPI&Version=2020-06-01&ActivityId=177916828715
```

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

### ListAnActivityStartAndEndTimeAPI - Get Live Room Start and End Times

Source: https://www.volcengine.com/docs/3019/100297

Retrieves the start and end times for a live room. This API is useful for scheduling and planning purposes.

```APIDOC
## GET /live/activity/times/{activityId}

### Description
Retrieves the start and end times for a specific live room.

### Method
GET

### Endpoint
/live/activity/times/{activityId}

### Parameters
#### Path Parameters
- **activityId** (string) - Required - The unique identifier of the live room.

### Response
#### Success Response (200)
- **startTime** (string) - The start time of the live room (ISO 8601 format).
- **endTime** (string) - The end time of the live room (ISO 8601 format).

#### Response Example
```json
{
  "startTime": "2023-11-15T09:00:00Z",
  "endTime": "2023-11-15T11:00:00Z"
}
```
```

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

### GetActivityBanIps API Request Example (GET)

Source: https://www.volcengine.com/docs/3019/1414487

This is an example of how to make a GET request to the GetActivityBanIps API to retrieve a list of banned IP addresses for a given live room. It includes the base URL, API action, version, and the required ActivityId.

```http
GET https://livesaas.volcengineapi.com/?Action=GetActivityBanIps&Version=2023-08-01&ActivityId=177985****487296
```

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

### Initialize Multiple Player Instances

Source: https://www.volcengine.com/docs/3019/1205059

This example demonstrates initializing multiple player instances (live and VOD) on the same page. Each instance can be controlled independently. Ensure unique IDs for each instance.

```javascript
var webSDK1 = new window.ByteLiveWebSDK({
  activityId: 169410856822****,
  signToken: 'JC****',
  service: 'Demo',
  mode: 1,
  modules: [
    {
      id: "player1",  // 确保不同实例有不同的取值。
      mode: "player", // 由于仅支持单独接入播放器模块，因此 mode 取值固定为 player。
    }
  options: {}
})

webSDK1.emit('player.pause'); // 触发事件。
webSDK1.on('player.pause', () => {}); // 监听事件。

var webSDK2 = new window.ByteLiveWebSDK({
  vodPlayerToken: 'ceed74dcb2ceaba3c92a91fc2ebd****',
  vid: 'v03a49g10000cojk12bc77ua72bm****',
  vodPlayerConfigId: 'vcid-179665696630****',
  service: 'Demo',
  modules: [
    {
      id: "player2", // 确保不同实例有不同的取值。
      mode: "player", // 取值固定为 player。
    }
  ],
  options: {}
})

webSDK2.emit('player.pause'); // 触发事件。
webSDK2.on('player.pause', () => {}); // 监听事件。

```

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

### Full Example: Join and Leave Live Room with Player (Objective-C)

Source: https://www.volcengine.com/docs/3019/1206173

This comprehensive Objective-C example demonstrates joining and leaving a live room using a custom player view. It includes setting up the activity details, joining the room, creating and configuring the `BDLPlayerView`, and handling both successful joins and errors. The `leaveLiveRoom` method is also provided to clean up resources.

```objectivec
@interface ViewController () 
@property (nonatomic, strong) BDLPlayerView *playerView;
@end

- (void)joinLiveRoom {
    BDLActivity *activity = [[BDLActivity alloc] init];
    activity.activityId = @(167808997736****);
    activity.token = @"JQ****";
    activity.isPortrait = YES;
    activity.authMode = BDLActivityAuthModePublic;
    
    [[BDLLiveEngine sharedInstance] joinLiveRoomWithActivity:activity
                                                     success:^{ 
        self.playerView =[[BDLPlayerView alloc] initWithPortrait:YES];
        self.playerView.popupSuperView = self.view;
        [self.view addSubview:self.playerView];
        [self.playerView mas_makeConstraints:^(MASConstraintMaker *make) {
            make.edges.equalTo(self.view);
        }];
    } failure:^(NSError * _Nonnull error) {
        NSLog(@"%@", error.localizedDescription);
    }];
}

- (void)leaveLiveRoom {
    [[BDLLiveEngine sharedInstance] leaveLiveRoom];
    [self.playerView removeFromSuperview];
    self.playerView = nil;
}
```

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

### GetInviterToken API Request Example (GET)

Source: https://www.volcengine.com/docs/3019/1400186

This example demonstrates how to make a GET request to the GetInviterToken API. It includes essential query parameters such as Action, Version, ActivityId, and either UserId or ExternalId. The URL structure is designed for direct API interaction.

```http
GET https://livesaas.volcengineapi.com/?Action=GetInviterToken&Version=2023-08-01&ActivityId=177985****487296&UserId=181876****470490&ExternalId=14039
```

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

### Configure SDK Initialization Parameters in JavaScript

Source: https://www.volcengine.com/docs/3019/101244

This example shows simplified SDK initialization parameters in JavaScript. The `mode` and `modules` parameters are now optional, with default values provided. A new parameter, `vodPlayerConfigId`, is introduced to specify the VOD player configuration.

```javascript
WebLiveSDK.createInstance({
  // mode: 1, // Optional, default value is 1
  // modules: [{mode: 'player', id: 'bytelive-default-player'}], // Optional
  vodPlayerConfigId: 'my-vod-player-config'
});
```

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

### Get Activity Export File Request Example

Source: https://www.volcengine.com/docs/3019/1377765

This example demonstrates how to make a GET request to the GetActivityExportFile API to retrieve exported live room data. It includes the base URL and the required query parameters such as Action, Version, ActivityId, and ExportId.

```http
GET https://livesaas.volcengineapi.com/?Action=GetActivityExportFile&Version=2023-08-01&ActivityId=1856****1234&ExportId=1877****1234
```

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

### Get Link User Amount API Request Example (HTTP)

Source: https://www.volcengine.com/docs/3019/1375509

This is an example of an HTTP GET request to the GetLinkUserAmount API. It demonstrates the required parameters such as Action, Version, and ActivityId for fetching the real-time number of connected users in a live stream.

```http
GET https://livesaas.volcengineapi.com/?Action=GetLinkUserAmount&Version=2023-08-01&ActivityId=1770****83012
```

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

### Initialize Web Player SDK with Sign Token (JavaScript)

Source: https://www.volcengine.com/docs/3019/142133

Example demonstrating how to initialize the Volcengine Web Player SDK using a `signToken`. This token is crucial for authenticating the user and authorizing playback. Ensure the `activityId` and `mode` are correctly set according to your live stream configuration.

```javascript
var webSDK = new window.ByteLiveWebSDK({
    activityId: 172291833994****,
    signToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJOaWNrTmFtZSI6IlRvbSIsIlVzZXJJZFN0ciI6Ijk4MDc2NzkiLCJJbnZpdGVyVG9rZW4iOiJhYmNkIiwiQ3VzdG9tQ29tbWVudCI6IuWMl-S6rCIsIkxldmVsSWQiOiIxMDA4NiIsIlRpbWVTdGFtcCI6MTY5NDUwMjQwMH0.97BgHXLsa_bRZB7EIavEbR2d4Wq***********',
    service: 'liveDemo',
    mode: 2, 
    ...
});
```

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

### 控制上传任务 - 启动 (TypeScript)

Source: https://www.volcengine.com/docs/3019/153067

调用 `start` 方法启动文件上传任务。该方法用于开始将本地文件推送到企业直播媒资库。

```typescript
uploader.start();
```

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

### Get Vod Player Token Request Example

Source: https://www.volcengine.com/docs/3019/1251475

This example demonstrates how to make a GET request to the GetVodPlayerToken API to retrieve a player token. The request includes the Action and Version parameters. This token is used to initialize the Web观播 SDK for video playback.

```http
GET https://livesaas.volcengineapi.com/?Action=GetVodPlayerToken&Version=2023-08-01
```

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

### Initialize SDK with Auth Info (Objective-C)

Source: https://www.volcengine.com/docs/3019/1185540

Initializes the VolcEngine SDK with provided authentication information. This method should be called after establishing a network connection. It takes an `BDLiveAuthInfo` object for authentication and a completion block to handle initialization status.

```objectivec
- (void)startWithAuthInfo:(BDLiveAuthInfo *)authInfo
                 complete:(BDLiveManagerCompleteBlock)complete;
```

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

### Get Live Room Sensitive Words API Request Example

Source: https://www.volcengine.com/docs/3019/124325

This is an example of a GET request to the GetActivityAntidirtAPI to query sensitive words. It includes required parameters such as Action, Version, ActivityId, PageNo, and PageItemCount, with an optional Content parameter for keyword search.

```http
GET https://livesaas.volcengineapi.com/?Action=GetActivityAntidirtAPI&Version=2020-06-01&ActivityId=1772441830705&PageNo=1&PageItemCount=10&Content=a
```

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

### Complete Example: Joining and Leaving a Live Room

Source: https://www.volcengine.com/docs/3019/1206173

A comprehensive example demonstrating how to join and leave a live room using the BDL SDK. It includes setting up activity parameters like activity ID, token, and authentication mode, and handling success and failure callbacks. This example also incorporates the logic for view transition and floating player interaction.

```objectivec
@interface ViewController () <BDLFloatingPlayerDelegate>
@property (nonatomic, strong) BDLFloatingPlayer *floatingPlayer;
@property (nonatomic, strong) BDLBasePlayerView *playerView;
@property (nonatomic, strong) BDLLivePullViewController *livePullViewController;
@end


- (void)joinLiveRoom {
    BDLActivity *activity = [[BDLActivity alloc] init];
    activity.activityId = @(167808997736****);
    activity.token = @"JQ****";
    activity.isPortrait = YES;
    activity.authMode = BDLActivityAuthModePublic;

    [[BDLLiveEngine sharedInstance] joinLiveRoomWithActivity:activity
                                                     success:^{
        self.floatingPlayer = [[BDLFloatingPlayer alloc] initWithPortrait:YES];
        self.floatingPlayer.delegate = self;
        [self.floatingPlayer showWithCloseButton:YES];
    } failure:^(NSError * _Nonnull error) {
        NSLog(@"%@", error.localizedDescription);
    }];
}

- (void)leaveLiveRoom {
    [[BDLLiveEngine sharedInstance] leaveLiveRoom];
    [self.playerView removeFromSuperview];
    self.playerView = nil;
}

- (void)viewWillTransitionToSize:(CGSize)size withTransitionCoordinator:(id<UIViewControllerTransitionCoordinator>)coordinator {
    [super viewWillTransitionToSize:size withTransitionCoordinator:coordinator];

    UIInterfaceOrientation orientation = UIInterfaceOrientationUnknown;
    if (@available(iOS 13, *)) {
        orientation = self.navigationController.view.window.windowScene.interfaceOrientation;
    } else {
        orientation = UIApplication.sharedApplication.statusBarOrientation;
    }
    [self.floatingPlayer setUIOrientation:orientation];
}

- (void)floatingPlayerDidSingleTap:(BDLFloatingPlayer *)floatingPlayer {
    [self.floatingPlayer hide];
    BDLBasePlayerView *basePlayerView = [floatingPlayer removeBasePlayerView];
    BDLLivePullViewController *vc = [[BDLLiveEngine sharedInstance] getLivePullViewControllerWithBasePlayerView:basePlayerView];
    vc.delegate = self;
    vc.actionProvider = self;
    self.livePullViewController = vc;
    self.floatingPlayer = nil;
    [self.navigationController pushViewController:self.livePullViewController animated:YES];
}
```

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

### GetActivityRedPacket API Request Example

Source: https://www.volcengine.com/docs/3019/1471375

This is an example of a GET request to the GetActivityRedPacket API endpoint. It includes parameters for specifying the action, version, activity ID, and red packet ID.

```http
GET https://livesaas.volcengineapi.com/?Action=GetActivityRedPacket&Version=2023-08-01&ActivityID=182492****234844&RedPacketID=182509****702096
```

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

### ListUserBehaviorDataAPIV2 Request Example

Source: https://www.volcengine.com/docs/3019/167660

This is an example of a GET request to the ListUserBehaviorDataAPIV2 endpoint. It demonstrates how to include various parameters to filter and retrieve user behavior data for a specific live stream activity.

```http
GET https://livesaas.volcengineapi.com/?Action=ListUserBehaviorDataAPIV2&Version=2020-06-01&ActivityId=1772****8085&PageNo=1&PageItemCount=10&ScrollId=abc&Name=123&StartTime=1642070520&EndTime=1642070920&IsMerge=0&Channel=1&PlayStatus=10&IsMergeUserId=0&Extra=qwe
```

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

### Enter a Live Room with a Full Player in Java

Source: https://www.volcengine.com/docs/3019/1253556

This code example shows how to enter a live room and set up a full player without custom UI. It initializes the TVULiveRoomServer, inflates a PlayerView layout, sets the authentication mode, binds the player view, adds it to a container, and starts the live room stream.

```Java
// 创建竖屏直播间 TVULiveRoomServer 实例。如需创建横屏直播间 TVULiveRoomServer 实例，请将 TVULiveRoomServer.SERVER_TYPE_PORTRAIT_LIVEROOM 替换为 TVULiveRoomServer.SERVER_TYPE_LIVEROOM。
TVULiveRoomServer mServer = new TVULiveRoomServer(this, activityId, token, TVULiveRoomServer.SERVER_TYPE_PORTRAIT_LIVEROOM);
// 引入播放器模块 PlayerView 实例。
PlayerView playerView = (PlayerView) LayoutInflater.from(this).inflate(com.bytedance.live.sdk.R.layout.tvu_player_layout, null, false);
// 将直播间鉴权模式设置为公开，观众无需登录即可观看直播、查看评论等。
mServer.setRoomAuthMode(TVULiveRoom.TVURoomAuthMode.PUBLIC);
// 绑定 PlayerView 实例和 TVULiveRoomServer 实例。
mServer.setPlayerView(playerView);
// 引入您的播放器容器。
FrameLayout playerViewContainer = findViewById(R.id.player_view_container);
// 将 PlayerView 实例放入容器中。
playerViewContainer.addView(playerView, new FrameLayout.LayoutParams(ViewGroup.LayoutParams.MATCH_PARENT, ViewGroup.LayoutParams.MATCH_PARENT));
// 启动 TVULiveRoomServer 实例。实例启动后，播放器会自动播放视频。
mServer.start();

Java
```

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

### Objective-C: Handle Picture-in-Picture Start Preparation

Source: https://www.volcengine.com/docs/3019/1185541

This Objective-C method is called just before the system Picture-in-Picture mode is about to start. It allows for any necessary preparations before entering PiP mode.

```objectivec
- (void)basePlayerViewWillStartPictureInPicture:(BDLBasePlayerView *)basePlayerView;

```

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

### GetSubAccount API Request Example

Source: https://www.volcengine.com/docs/3019/1377761

This is an example of how to make a GET request to the GetSubAccount API. It demonstrates the URL structure and required parameters for querying a sub-account.

```http
GET https://livesaas.volcengineapi.com/?Action=GetSubAccount&Version=2023-08-01&Name=on_2222222222222
```

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

### AutoStartConfig API

Source: https://www.volcengine.com/docs/3019/100061

This section details the parameters for configuring automatic live streaming start settings.

```APIDOC
## AutoStartConfig API

### Description
Configure the automatic start settings for live streams, including repeat frequency and deadlines.

### Parameters
#### Request Body
- **RepeatType** (Integer) - Optional - The frequency for repeating the stream after auto-start. Default is `0`. Values: `0` (no repeat), `1` (daily), `2` (custom).
- **RepeatDeadline** (Long) - Optional - The deadline for repeating the stream (Beijing time), in Unix timestamp format (seconds). Effective when `RepeatType` is `1` or `2`.
- **RecurrenceRule** (String) - Optional - Custom recurrence rule in RFC5545 RRULE format. `FREQ` can be `DAILY` or `WEEKLY`. `INTERVAL` is an integer from `1-30` representing the repeat interval. Effective when `RepeatType` is `2`.
```

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

### ListAnActivityStartAndEndTimeAPI - Get Live Room Start and End Times

Source: https://www.volcengine.com/docs/3019/100073

Retrieves the start and end times for each live broadcast session in a given live room. It requires the ActivityId of the live room and provides details like broadcast order, start time, and end time.

```APIDOC
## GET /livesaas.volcengineapi.com

### Description
Retrieves the start and end times for each live broadcast session in a given live room.

### Method
GET

### Endpoint
https://livesaas.volcengineapi.com/

### Parameters
#### Query Parameters
- **Action** (String) - Required - The name of the API. (`ListAnActivityStartAndEndTimeAPI`)
- **Version** (String) - Required - The API version. (`2020-06-01`)
- **ActivityId** (Long) - Required - The ID of the live room. You can query this ID using the `ListActivityAPI`. Ensure the live room is visible to the sub-account when calling with a sub-account.

### Request Example
```
GET https://livesaas.volcengineapi.com/?Action=ListAnActivityStartAndEndTimeAPI&Version=2020-06-01&ActivityId=177916828715
```

### Response
#### Success Response (200)
- **StartAndEndTime** (Array of Objects) - An array containing the start and end times for each broadcast session.
  - **OrderNumber** (Integer) - The broadcast sequence number.
  - **StartTime** (Long) - The broadcast start time (Unix timestamp in seconds).
  - **EndTime** (Long) - The broadcast end time (Unix timestamp in seconds).

#### Response Example
```json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListAnActivityStartAndEndTimeAPI",
        "Version": "2020-06-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "StartAndEndTime": [
            {
                "OrderNumber": 1,
                "StartTime": 1625811440,
                "EndTime": 1625811571
            },
            {
                "OrderNumber": 2,
                "StartTime": 1625811609,
                "EndTime": 1626405481
            },
            {
                "OrderNumber": 3,
                "StartTime": 1626405692,
                "EndTime": 0
            }
        ]
    }
}
```

### Error Handling
Refer to the common error codes and error codes for detailed information. (Access public error codes and error codes for detailed information.)

### Notes
- **Request Frequency**: The request frequency limit is **120 times/minute** per user.
- **Prerequisites**: Ensure you have the Alibaba Cloud main account or a sub-account with **Data Statistics** > **View Only** or **Editable** permissions for the live room. Refer to Sub-account Management for details.
```

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

### Configure and Enter Live Room (Objective-C)

Source: https://www.volcengine.com/docs/3019/891908

This snippet demonstrates how to configure and enter a live streaming room using the BDLLiveStreaming SDK. It involves creating a model with activity ID and secret key, optionally configuring UI features like beauty filters and camera switches, setting up screen recording extensions if needed, customizing comment cells, and setting language preferences before joining the live room.

```objectivec
#import <BDLive/BDLive.h>
// 1. 创建 BDLLiveStreamingModel 实例
BDLLiveStreamingModel *model = [[BDLLiveStreamingModel alloc] init];
// 1.1 输入获取到的直播间活动 ID 和开播密钥
model.activityId = ACTIVITY_ID; // 将 ACTIVITY_ID 替换为直播间活动 ID
model.secretKey = SECRET_KEY; // 将 SECRET_KEY 替换为开播密钥

// 1.2（可选）配置是否显示指定按钮
BDLFeatureEntranceConfiguration *featureEntranceConfig = BDLLiveStreaming.sharedInstance.liveStreamingConfiguration.featureEntranceConfig;
featureEntranceConfig.showBeautyEntrance = YES; // 是否显示美颜入口按钮。YES：显示。确保您已配置美颜、滤镜和道具贴纸功能。NO：不显示。默认值：YES
featureEntranceConfig.showPropsEntrance = YES; // 是否显示道具入口按钮。YES：显示。确保您已配置美颜、滤镜和道具贴纸功能。NO：不显示。默认值：YES
featureEntranceConfig.showCloudTemplateEntrance = YES; // 是否显示模板入口按钮。YES：显示。NO：不显示。默认值：YES
featureEntranceConfig.showPendentEntrance = YES; // 是否显示挂件和图层入口按钮。YES：显示。NO：不显示，并关闭模板功能，即不显示模板入口按钮、不支持新增和编辑模板。默认值：YES
featureEntranceConfig.showSwitchCamera = YES; // 是否显示前后摄像头翻转入口按钮。YES：显示。NO：不显示。默认值：YES
featureEntranceConfig.showRotateScreen = YES; // 是否显示横竖屏切换入口按钮。YES：显示。NO：不显示。默认值：YES
featureEntranceConfig.showChangeResolution = YES; // 是否显示清晰度切换入口按钮。YES：显示。NO：不显示。默认值：YES
featureEntranceConfig.showMediaMergeEntrance = NO; // 是否显示媒体合流入口按钮。YES：显示。NO：不显示。默认值：NO
featureEntranceConfig.showTextMergeEntrance = NO; // 是否显示文字合流入口按钮。YES：显示。NO：不显示。默认值：NO

// 1.3 （可选）配置是否支持新增和编辑模板
featureEntranceConfig.editCloudTemplateEnable = YES; // 是否支持新增和编辑模板。YES：支持，即便 showCloudTemplateEntrance 取值为 NO，也会显示模板入口按钮。NO：不支持。默认值：YES

// 1.4 （可选）配置是否支持编辑直播间信息
featureEntranceConfig.editLiveInfoEnable = YES; // 是否支持编辑直播间的横屏封面和标题。YES：支持。NO：不支持。默认值：NO

// 1.5（可选）配置录屏直播功能。该功能仅适用于 iOS 12 及以上版本。有关如何实现该功能的详细信息，请参考进阶功能 > 录屏直播
if (@available(iOS 12.0, *)) {
   model.extensionBundleId = @"BUNDLE_ID"; // 将 BUNDLE_ID 替换为屏幕共享扩展的 Bundle Identifier
   model.groupId = @"GROUP_ID"; // 将 GROUP_ID 替换为 App group 的 Container ID
}

// 1.6（可选）自定义评论 cell。您可以自定义评论的文字内容、样式或替换表情图片。以下示例代码在评论区中增加随机字符串
BDLSCommentViewConfiguration *commentViewConfig = BDLLiveStreaming.sharedInstance.liveStreamingConfiguration.commentViewConfig;
commentViewConfig.customizeCommentCell = ^(BDLStreamingCommentView * _Nonnull view, BDLStreamCommentCell * _Nonnull commentViewCell, BDLPollingChatModel * _Nonnull comment) {
    // 创建随机字符串
    NSMutableAttributedString *attrStr = [[NSMutableAttributedString alloc] initWithString:[NSString stringWithFormat:@"%02d ", arc4random() % 100] attributes:@{
        NSFontAttributeName : [UIFont systemFontOfSize:14],
        NSForegroundColorAttributeName : [UIColor redColor]
    }];
    // 拼接现有评论区内容
    if (commentViewCell.textView.attributedText) {
        [attrStr appendAttributedString:commentViewCell.textView.attributedText];
    }
    // 将新的 attributeString 传入 cell
    commentViewCell.textView.attributedText = attrStr;
};

// 1.7（可选）在进入直播间前，设置 SDK 的语言类型，即开播端所有页面展示的语言。如不设置，则默认与系统语言一致，如系统语言非 SDK 支持的语言类型，则默认为英文。取值如下：BDLLanguageTypeChinese（简体中文）、BDLLanguageTypeEnglish（英文）、BDLLanguageTypeJapanese（日文）、BDLLanguageTypeTraditional（繁体中文）、BDLLanguageTypeKorean（韩语）、BDLLanguageTypeThai（泰语）、BDLLanguageTypeVietnamese（越南语）、BDLLanguageTypeArabic（阿拉伯语）、BDLLanguageTypeTurkish（土耳其语）、BDLLanguageTypeSpanish（西班牙语）、BDLLanguageTypeIndonesian（印尼语）、BDLLanguageTypePortuguese（葡萄牙语）、BDLLanguageTypeRussian（俄语）。
BDLSMultiLanguageConfiguration *languageConfig = BDLLiveStreaming.sharedInstance.liveStreamingConfiguration.languageConfig;
languageConfig.preferLanguage = BDLLanguageTypeChinese;
// 1.8 (可选）自定义 SDK 中展示的文案。适用于对 SDK 中展示的文案不满意，想替换为自定义文案的场景。以下示例代码将 SDK 语言类型为简体中文、key 为 cancel 的文案变更为 Cancel!。
/**
  * @param language SDK 的语言类型，即开播端所有页面展示的语言。取值如下：BDLLanguageTypeChinese（简体中文）、BDLLanguageTypeEnglish（英文）、BDLLanguageTypeJapanese（日文）、BDLLanguageTypeTraditional（繁体中文）、BDLLanguageTypeKorean（韩语）、BDLLanguageTypeThai（泰语）、BDLLanguageTypeVietnamese（越南语）、BDLLanguageTypeArabic（阿拉伯语）、BDLLanguageTypeTurkish（土耳其语）、BDLLanguageTypeSpanish（西班牙语）、BDLLanguageTypeIndonesian（印尼语）、BDLLanguageTypePortuguese（葡萄牙语）、BDLLanguageTypeRussian（俄语）。
  * @param key 文案的 key。
  * @param originString 默认展示的文案内容。
  * @return 自定义的文案内容，用于替换默认展示的文案内容。
 */
languageConfig.customLanguageString = ^NSString * _Nonnull(BDLLanguageType language, NSString * _Nonnull key, NSString * _Nonnull originString) {
    if (language == BDLLanguageTypeChinese && [key isEqualToString:@"cancel"]) {
        return @"Cancel!";
    }
    return originString;
};
    
// 2. 进入直播间
[[BDLLiveStreaming sharedInstance] joinLiveStreamingWithModel:model
                                                      success:^(void) {
    // 3. 如果成功进入直播间，获取直播间页面
    BDLLiveStreamingController *livePushVC = [[BDLLiveStreaming sharedInstance] getLiveStreamingController];
    livePushVC.modalPresentationStyle = UIModalPresentationFullScreen;
    // 3.1 设置直播间代理，监听直播间变化。详见设置直播间事件回调
    livePushVC.delegate = self;
   
    // 3.2（可选）配置直播间。详见自定义配置
     
    // 4. 显示直播间 ViewController(livePushVC) 

```

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

### 引入 Web 观播 SDK 样式和脚本文件 (HTML)

Source: https://www.volcengine.com/docs/3019/101258

根据不同的接入场景（PC 端、移动端、模块化接入、整页接入、单独接入播放器模块），在 `index.html` 文件中引入对应的 CSS 和 JavaScript 文件。版本号可以直接修改以更新 SDK 版本。

```html
<link rel="stylesheet" href="https://mediaservice-fe.volccdn.com/obj/vcloud-fe/livesaas-client/pc/css/index.2.1.38.css">
<script src="https://mediaservice-fe.volccdn.com/obj/vcloud-fe/livesaas-client/pc/js/index.2.1.38.js"></script>
```

```html
<link rel="stylesheet" href="https://mediaservice-fe.volccdn.com/obj/vcloud-fe/livesaas-client/player-pc/css/index.2.1.38.css">
<script src="https://mediaservice-fe.volccdn.com/obj/vcloud-fe/livesaas-client/player-pc/js/index.2.1.38.js"></script>
```

```html
<link rel="stylesheet" href="https://mediaservice-fe.volccdn.com/obj/vcloud-fe/livesaas-client/mobile/css/index.2.1.38.css">
<script src="https://mediaservice-fe.volccdn.com/obj/vcloud-fe/livesaas-client/mobile/js/index.2.1.38.js"></script>
```

```html
<link rel="stylesheet" href="https://mediaservice-fe.volccdn.com/obj/vcloud-fe/livesaas-client/mobile-all/css/index.2.1.38.css">
<script src="https://mediaservice-fe.volccdn.com/obj/vcloud-fe/livesaas-client/mobile-all/js/index.2.1.38.js"></script>
```

```html
<link rel="stylesheet" href="https://mediaservice-fe.volccdn.com/obj/vcloud-fe/livesaas-client/player-mobile/css/index.2.1.38.css">
<script src="https://mediaservice-fe.volccdn.com/obj/vcloud-fe/livesaas-client/player-mobile/js/index.2.1.38.js"></script>
```

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

### LiveSaaS API Request Example

Source: https://www.volcengine.com/docs/3019/132536

Example of a GET request to the Volcengine LiveSaaS API. This demonstrates how to structure a request to retrieve custom activity messages, including basic and stream messages, and real-time online numbers.

```http
GET https://livesaas.volcengineapi.com/?Action=GetCustomActMsgAPI&Version=2020-06-01&ActivityId=172183460671&NeedActMsg=1&NeedActBasicMsg=1&NeedActStreamMsg=1&NeedRealTimeOnlineNumber=1
```

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

### uni-app SDK 目录结构

Source: https://www.volcengine.com/docs/3019/1188883

展示了 `volc-mini-sdk` 压缩包解压后的文件和文件夹结构。了解此结构有助于正确放置 SDK 文件并进行后续集成。

```plaintext
|volc-mini-sdk
|---lib/         SDK 依赖文件
|---assets/      静态文件索引
|---components/
|---|---chat/    聊天组件
|---|---player/  播放器组件
|---|---volc-live-portrait  竖屏直播间整体组件
|---|---volc-live-landscape 横屏直播间整体组件
|---index.js     初始化模块
|---store/       数据缓存目录

```

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

### Get Live Room Status

Source: https://www.volcengine.com/docs/3019/130847

Gets the current status of the live room. Returns an integer representing states like not started, live, preview, replay, or ended.

```java
public int getLiveRoomStatus()
```

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

### POST /livesaas.volcengineapi.com

Source: https://www.volcengine.com/docs/3019/100053

Creates a live room for live streaming activities. You can specify various parameters to configure the live room, such as its name, start and end times, whether to copy streams from an existing room, and template configurations.

```APIDOC
## POST /livesaas.volcengineapi.com?Action=CreateActivityAPIV2 &Version=2020-06-01

### Description
Calls the `CreateActivityAPIV2` interface to create a live room for live streaming activities. After successful creation, you can obtain the live room ID and use it to decorate and manage the live room by calling other interfaces.

### Method
POST

### Endpoint
https://livesaas.volcengineapi.com/?Action=CreateActivityAPIV2 &Version=2020-06-01

### Parameters
#### Query Parameters
- **Action** (String) - Required - The name of the interface. The current API name is `CreateActivityAPIV2`.
- **Version** (String) - Required - The version of the interface. The current API version is `2020-06-01`.

#### Request Body
- **Name** (String) - Required - The name of the live room. Length must be between 1 and 150 characters.
- **LiveTime** (Long) - Optional - The start time of the live broadcast, defaults to the current time. Unix timestamp in seconds. Supports minute-level precision.
- **OldId** (Long) - Optional - The ID of the live room to be copied. If you need to copy a new live room from an existing one, this parameter is required.
- **CopyStream** (Boolean) - Optional - Whether to copy the live stream when copying a live room. Defaults to `false`.
- **TemplateId** (Long) - Optional - The ID of the live room template. If not provided, the default live room template is used. This parameter is only effective when `OldId` is not configured.
- **IsAutoEndEnable** (Integer) - Optional - Whether to enable the auto-end broadcast function. Defaults to `0` (disabled).
- **EndTime** (Long) - Optional - The end time of the live broadcast. Unix timestamp in seconds. Supports minute-level precision. Required and effective when `IsAutoEndEnable` is `1`.
- **ActivityType** (Integer) - Optional - The live broadcast mode. Defaults to `0` (video live broadcast).
- **LiveMode** (Integer) - Optional - The live broadcast delay type. Defaults to `0` (inherits configuration from the live template).
- **ViewUrlPath** (String) - Optional - The path field in the watch URL. If not filled, it will be automatically generated by the system.
- **CoverImage** (String) - Optional - The cover image URL for landscape live broadcasts.
- **VerticalCoverImage** (String) - Optional - The cover image URL for portrait live broadcasts. If not set, it defaults to `CoverImage`.
- **SiteTags** (Array of SiteTags) - Optional - List of live room category tags.
- **TextSiteTags** (Array of TextSiteTags) - Optional - List of live room text tags.
- **IsAnswerRepetitionEnable** (Integer) - Optional - Whether to enable the answer repetition function. Defaults to `0` (disabled).
- **LiveLayout** (Integer) - Optional - The video layout. Defaults to `2` (pure video).
- **CreatorName** (String) - Optional - The account information of the live room creator. If not provided when using the main account, the live room will be created by the main account.
- **IsAutoStartEnable** (Integer) - Optional - Whether to enable the automatic start broadcast function. Defaults to `0` (disabled). Effective only when `ActivityType` is `1` (recorded live broadcast).
- **LoopVideos** (Array of LoopVideos) - Optional - Videos for recorded live broadcasts. Total video size must be less than or equal to 200 GB. Effective only when `ActivityType` is `1`.
- **IsReplayAutoOnlineEnable** (Integer) - Optional - Whether to enable automatic online publishing of replays. Defaults to `0` (disabled).
- **Vid** (String) - Optional - The Vid of the video in the video library or live broadcast staging. The new live room will be in **Replay** status.
- **AutoStartConfig** (Object of AutoStartConfig) - Optional - Configuration for automatic start broadcast repetition. Effective only when `IsAutoStartEnable` is `1`.

### SiteTags Structure
- **Value** (String) - Required - The optional value of the category tag.
- **Index** (Integer) - Required - The index value of the category tag, indicating its display position in the console. Smaller index means higher priority.

### Request Example
```json
{
  "Name": "My Live Room",
  "LiveTime": 1642668850,
  "EndTime": 1718078834,
  "ActivityType": 0,
  "CoverImage": "https://example.com/cover.jpg"
}
```

### Response
#### Success Response (200)
- **ActivityId** (String) - The ID of the created live room.
- **ActivityUrl** (String) - The URL to access the live room.

#### Response Example
```json
{
  "ActivityId": "act_abc123xyz789",
  "ActivityUrl": "https://live.example.com/room/act_abc123xyz789"
}
```
```

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

### GetActivityLoginSecret API Request Example (GET)

Source: https://www.volcengine.com/docs/3019/1927153

This example demonstrates how to call the GetActivityLoginSecret API using the HTTP GET method. It includes the necessary parameters like Action, Version, ActivityId, and Mode to retrieve a login secret for a specific live or on-demand room. The Mode parameter determines whether the login is public or requires custom authentication.

```http
GET https://livesaas.volcengineapi.com/?Action=GetActivityLoginSecret&Version=2023-08-01&ActivityId=181****461451&Mode=2
```

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

### BDLiveManager Start Method

Source: https://www.volcengine.com/docs/3019/1185540

Method to start the live broadcast service with authentication information.

```APIDOC
## BDLiveManager Methods

### startWithAuthInfo:complete:

* **Description**: Starts the live broadcast service using provided authentication information.
* **Method**: - (void)startWithAuthInfo:(NSDictionary *)authInfo complete:(void (^)(BOOL success, NSError *error))complete;
* **Parameters**:
    * **authInfo** (NSDictionary) - Required. Authentication details for the live broadcast.
    * **complete** (void (^)(BOOL success, NSError *error)) - Callback block executed upon completion, indicating success or failure with an error.
```

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

### GetVoteStatisticsAPI Request Example (HTTP)

Source: https://www.volcengine.com/docs/3019/170952

This is an example of an HTTP GET request to the GetVoteStatisticsAPI. It includes all mandatory parameters required to retrieve vote data for a specified live broadcast room and vote.

```http
GET https://livesaas.volcengineapi.com/?Action=GetVoteStatisticsAPI&Version=2020-06-01&ActivityId=1231231231&PageNo=1&PageCount=10&VoteId=vote1754472505032763
```

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

### Volcengine API: ListActivityRedPacket Request Example

Source: https://www.volcengine.com/docs/3019/1471376

Example of a GET request to the ListActivityRedPacket API endpoint. This request retrieves a list of activity red packets associated with a specific ActivityID. Parameters include Action, Version, ActivityID, PageItemCount, and PageNo.

```http
GET https://livesaas.volcengineapi.com/?Action=ListActivityRedPacket&Version=2023-08-01&ActivityID=182492****234844&PageItemCount=10&PageNo=1
```
Tokens:
Raw