# 边看边玩

# 全屏半屏切换

# 监听窗口尺寸变化事件

# 接口说明

用于监听窗口尺寸变化事件，建议在SDK初始化完成后立即调用此接口进行监听。在边看边玩场景中，调用此接口后将会显示放大缩小按钮，用户点击按钮后，触发全屏/半屏切换，根据容器大小，动态调整游戏UI，进行适配。了解更多内容请阅读芒果tv小游戏官方文档《边看边玩-全屏/半屏》 (opens new window)。

sdkInstance.onWindowResize(listener);

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
listener	function	是	--	事件回调函数

# 返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 `0` 时表示接口调用成功，其他非 `0` 状态码均表示接口调用失败
data	object / null	接口调用成功时返回窗口尺寸信息，失败时返回 `null`
data.size	object	窗口尺寸信息
data.size.windowWidth	number	窗口宽度
data.size.windowHeight	number	窗口高度
message	string	接口调用成功或失败时的相应描述信息

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 定义事件回调函数
const listener = function(response) {
  // code 非 0 时表示接口调用失败
  if (response.code != 0) {
    return;
  }

  // 输出窗口尺寸信息
  console.log(response.data); // { size: { windowHeight: 2590, windowWidth: 1260 } }
}

// 启动监听，监听窗口尺寸变化事件
sdkInstance.onWindowResize(listener);

// 游戏结束时取消监听（可选）
sdkInstance.offWindowResize(listener);

# 取消监听窗口尺寸变化事件

# 接口说明

用于取消监听窗口尺寸变化事件。

sdkInstance.offWindowResize(listener);

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
listener	function	否	--	通过 `onWindowResize` 绑定的事件回调函数

# 返回值说明

无

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 定义事件回调函数
const listener = function(response) {
  // code 非 0 时表示接口调用失败
  if (response.code != 0) {
    return;
  }

  // 输出窗口尺寸信息
  console.log(response.data); // { size: { windowHeight: 2590, windowWidth: 1260 } }
}

// 启动监听，监听窗口尺寸变化事件
sdkInstance.onWindowResize(listener);

// 游戏结束时取消监听（可选）
sdkInstance.offWindowResize(listener);

# 声音适配

# 显示音量控制按钮

# 接口说明

用于显示音量控制按钮。在边看边玩场景中，可以控制游戏内声音的播放、暂停或者调整音量。了解更多内容请阅读芒果tv小游戏官方文档《边看边玩-声音适配》 (opens new window)。

sdkInstance.showVolume(options);

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
enabled	boolean	否	false	为 `true` 时显示音量控制按钮，反之隐藏音量控制钮
defaultVolume	number	否	0	游戏初始音量，范围 `0 ~ 1`
success	function	否	--	接口调用成功的回调函数
fail	function	否	--	接口调用失败的回调函数
complete	function	否	--	接口调用完成的回调函数，成功或失败均会调用

# 返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 `0` 时表示接口调用成功，其他非 `0` 状态码均表示接口调用失败
data	object / null	接口调用成功时返回相应结果（因芒果tvAPI原因，此处可能为空），失败时返回 `null`
message	string	接口调用成功或失败时的相应描述信息

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

sdkInstance.showVolume({
  enabled: true, // true 显示，false 隐藏
  defaultVolume: 0.55, // 音量值，范围 0~1
  success: function(response) {
    console.log(response);
  },
  fail: function(error) {
    console.log(error);
  },
  complete: function(result) {
    // do something here...
  }
});

# 监听用户调节音量事件

# 接口说明

用于监听用户调节音量事件，建议在SDK初始化完成后立即调用此接口进行监听。

sdkInstance.onVolumeChange(listener);

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
listener	function	是	--	事件回调函数

# 返回值说明

WARNING

返回值格式：JSON 格式。

选项	类型	说明
code	number	响应状态码，为 `0` 时表示接口调用成功，其他非 `0` 状态码均表示接口调用失败
data	object / null	接口调用成功时返回音量值信息，失败时返回 `null`
data.volume	number	音量值，范围 `0 ~ 1`
message	string	接口调用成功或失败时的相应描述信息

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 定义事件回调函数
const listener = function(response) {
  // code 非 0 时表示接口调用失败
  if (response.code != 0) {
    return;
  }

  // 输出音量值信息
  console.log(response.data.volume); // 0.55
}

// 启动监听，监听用户调节音量事件
sdkInstance.onVolumeChange(listener);

// 游戏结束时取消监听（可选）
sdkInstance.offVolumeChange(listener);

# 取消监听用户调节音量事件

# 接口说明

用于取消监听用户调节音量事件。

sdkInstance.offVolumeChange(listener);

# 参数说明

参数说明如下表所示：

选项	类型	必填	默认值	说明
listener	function	否	--	通过 `onVolumeChange` 绑定的事件回调函数

# 返回值说明

无

# 示例代码

注：示例代码中的参数或选项均为演示数据，仅供参考，谢谢！

// 定义事件回调函数
const listener = function(response) {
  // code 非 0 时表示接口调用失败
  if (response.code != 0) {
    return;
  }

  // 输出音量值信息
  console.log(response.data.volume); // 0.55
}

// 启动监听，监听用户调节音量事件
sdkInstance.onVolumeChange(listener);

// 游戏结束时取消监听（可选）
sdkInstance.offVolumeChange(listener);

← 分享上报角色信息 →