图谱 API 版

小组直播视频

有关直播视频 API 的详情，请访问我们的直播视频文档。

创建

您可以从以下路径向 live_videos 连线发出 POST 请求：

/{group-id}/live_videos

向此连线发出 POST 请求时，系统将创建一段直播视频。

参数

名称	描述
`app_attribution_tag` 数字字符串或整数	将在动态中显示的直播视频的归因分析标签。
`attribution_app_id` 数字字符串或整数	归因应用的编号。
`content_tags` list<numberic string>	描述视频内容的标签。使用带 `type=adinterest` 的搜索端点获取可能的编号。查询示例： /search?type=adinterest&q=sunsets
`description` UTF-8 字符串	有关直播视频的描述。支持表情。
`encoding_settings` 字符串	主播为相关直播所使用的编码设置小组的标识符。此参数目前仅用于 360 度全景直播。要传递给此参数的值是编码设置的预设 `identifier` 键值。通过查询 `/broadcaster_encoding_settings` 图谱 API 端点（`GET` 查询），可找到编码预设值。
`event_params` 整数	主播计划的直播开始 Unix 时间戳。
`fisheye_video_cropped` 布尔值	单鱼眼视频是否经过裁剪。
`front_z_rotation` 浮点数	单鱼眼视频的正面 z 轴旋转角度。
`game_id` 数字字符串或整数	设置视频所介绍的游戏。使用带 `type=game` 的搜索端点获取可能的编号。查询示例： /search?type=game&=pubg
`game_specs` 游戏规格参数	设置元数据，以表示待执行归因分析的游戏。
`is_spherical` 布尔值	表示直播是 360 度全景直播的标记。
`live_encoders` list<numberic string or integer>	会将信息发送到相关直播视频的直播编码器。
`original_fov` int64	相机的初始视野。
`post_surfaces_blacklist` list<enum{1, 2, 3, 4, 5}>	不会显示帖子的界面黑名单，仅适用于动态体验。
`privacy` 隐私参数	相关直播视频的隐私。
`projection` enum{EQUIRECTANGULAR, CUBEMAP}	表示 360 度全景直播预期投影的标记。默认值为 EQUIRECTANGULAR。
`save_vod` 布尔值	是否应保存视频数据，以供后续以点播视频格式来使用。默认值为 true。（注意：此参数只能在创建时设置）
`schedule_custom_profile_image` 图片	将出现在预定直播动态和大厅中的自定义图片。
`spatial_audio_format` enum{ambiX_4}	表示空间音频直播的格式。未指定时，音频假定为单声道或立体声。
`status` enum {UNPUBLISHED, LIVE_NOW, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_CANCELED}	直播的状态。`LIVE_NOW` 直播为实时播放，且对用户可见。`UNPUBLISHED` 直播则正在准备中，且对其他用户不可见。此状态持续数小时后，未发布的直播可能会自动删除。请考虑使用这些预定的状态为将来创建一个有计划的直播。
`stereoscopic_mode` enum {MONO, LEFT_RIGHT, TOP_BOTTOM}	将相关视频的此标记设为立体声模式。
`stop_on_delete_stream`	如果在收到 `deleteStream` RTMP 命令时应停止直播，请将此参数设为 `true`。
`title` UTF-8 字符串	直播视频的标题。支持表情。

返回类型

此端点支持先写入后读取，并可读取返回类型中由 id 表示的节点。

Struct { id: numeric string, stream_url: string, secure_stream_url: string, stream_secondary_urls: List [ string ], secure_stream_secondary_urls: List [ string ], dash_ingest_url: string, }

验证规则

错误	描述
100	无效参数
200	权限错误

读取

功能

名称	描述
小组 API	此功能需通过应用审核。

示例

/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{group-id}/live_videos",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();

GET /v7.0/{group-id}/live_videos HTTP/1.1
Host: graph.facebook.com

// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{group-id}/live_videos"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];

/* make the API call */
FB.api(
    "/{group-id}/live_videos",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);

/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{group-id}/live_videos',
    'your-access-token'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */

请参阅我们的图谱 API 使用指南，详细了解图谱 API。

参数

名称描述

名称	描述
`broadcast_status` list<enum {UNPUBLISHED, LIVE, LIVE_STOPPED, PROCESSING, VOD, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_EXPIRED, SCHEDULED_CANCELED}>	支持指定返回哪种直播视频。没有值会返回所有状态类型。
`source` enum{target, owner}	默认值：`target` 待查询视频的来源。例如，`target` 会将直播视频传送到小组。小组直播视频仅支持 `target`。

broadcast_status

list<enum {UNPUBLISHED, LIVE, LIVE_STOPPED, PROCESSING, VOD, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_EXPIRED, SCHEDULED_CANCELED}>

支持指定返回哪种直播视频。没有值会返回所有状态类型。

source

enum{target, owner}

默认值：target

待查询视频的来源。例如，target 会将直播视频传送到小组。小组直播视频仅支持 target。

字段

读取此连线将会返回 JSON 格式的结果：

{ "data": [], "paging": {} }

data

直播视频字段清单。

paging

有关分页详情，请参阅图谱 API 指南。

验证规则

错误	描述
200	权限错误

更新

您无法在此端点上执行此操作。

删除

您无法在此端点上执行此操作。