Graph API 版本

群組直播視像

若要進一步了解直播視像 API，請瀏覽我們的直播視像文件。

建立

您可以從以下路徑向 live_videos 關係連線傳送 POST 要求：

/{group-id}/live_videos

發佈到此關係連線後，系統會建立一段直播視像。

參數

名稱	說明
`app_attribution_tag` 數字字串或整數	出現在動態消息上的直播視像歸因標籤。
`attribution_app_id` 數字字串或整數	歸因應用程式的編號。
`content_tags` 清單<數字字串>	描述影片內容的標籤。使用加入 `type=adinterest` 的搜尋端點來獲取可使用的編號。查詢範例： /search?type=adinterest&q=sunsets
`description` UTF-8 字串	直播視像的說明。支援表情符號。
`encoding_settings` 字串	直播主播用於此串流影片的編碼設定群組之識別碼。此參數目前僅適用於 360 度直播。要傳遞至此參數的值為編碼設定預設的 `identifier` 密鑰相應的值。您可以透過查詢 `/broadcaster_encoding_settings` Graph API 端點（`GET` 查詢）來找出編碼預設。
`event_params` 整數	直播主播打算開始直播的時間之時戳。
`fisheye_video_cropped` 布林值	表示單魚眼鏡頭影片是否經裁剪。
`front_z_rotation` 浮點數	單魚眼鏡頭影片的前 z 軸旋轉度數。
`game_id` 數字字串或整數	設定此影片所涉及的遊戲。使用加入 `type=game` 的搜尋端點來獲取可使用的編號。查詢範例： /search?type=game&=pubg
`game_specs` 遊戲規格參數	設定代表應歸因至哪個遊戲的元數據。
`is_spherical` 布林值	用以表示直播為 360 度直播的標示。
`live_encoders` 清單<數字字串或整數>	在此直播視像中用以直播的直播編碼器。
`original_fov` int64	相機的原始視野。
`post_surfaces_blacklist` 清單<列舉{1, 2, 3, 4, 5}>	無法看到帖子的黑名單，僅適用於動態消息體驗。
`privacy` 私隱參數	此直播視像的私隱設定。
`projection` 列舉{EQUIRECTANGULAR, CUBEMAP}	用以標記 360 度直播串流影片預期投影的標示。預設值為「EQUIRECTANGULAR」。
`save_vod` 布林值	表示是否應以隨選影片格式儲存影片資料以供日後使用。預設值為 true。（備註：只能在建立時設定）
`schedule_custom_profile_image` 圖像	將會出現在預定直播限時動態和播放大廳中的自訂圖像。
`spatial_audio_format` 列舉{ambiX_4}	標示空間音效串流影片的格式。未指定的音訊會被假定為單聲道或立體聲。
`status` 列舉{UNPUBLISHED, LIVE_NOW, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_CANCELED}	直播狀態。`LIVE_NOW` 直播表示目前正在直播，用戶可以看到。`UNPUBLISHED` 直播表示正在準備中，其他用戶無法看到。尚未發佈的直播如果一直維持此狀態，可能會在幾個小時後被自動刪除。在建立預定在未來開始的直播時，不妨考慮使用排程狀態。
`stereoscopic_mode` 列舉{MONO, LEFT_RIGHT, TOP_BOTTOM}	將此標示設定為此影片的立體模式。
`stop_on_delete_stream`	若系統應在收到 `deleteStream` RTMP 指令時停止串流影片，則將此設定為 `true`。
`title` UTF-8 字串	直播視像的名稱。支援表情符號。

傳回類型

此端點支援先寫後讀，並將讀取傳回類型中 id 所代表的節點。

結構 { 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 */

請參閱 Graph API 指南，進一步了解 Graph API。

參數

名稱說明

名稱	說明
`broadcast_status` 清單<列舉 {UNPUBLISHED, LIVE, LIVE_STOPPED, PROCESSING, VOD, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_EXPIRED, SCHEDULED_CANCELED}>	允許您指定傳回哪些類型的直播視像。如果沒有指定值，則會傳回所有狀態類型。
`source` 列舉{target, owner}	預設值：`target` 應向哪個來源查詢影片。例如，`target` 會在群組中直播視像。群組直播視像僅支援 `target`。

broadcast_status

清單<列舉 {UNPUBLISHED, LIVE, LIVE_STOPPED, PROCESSING, VOD, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_EXPIRED, SCHEDULED_CANCELED}>

允許您指定傳回哪些類型的直播視像。如果沒有指定值，則會傳回所有狀態類型。

source

列舉{target, owner}

預設值：target

應向哪個來源查詢影片。例如，target 會在群組中直播視像。群組直播視像僅支援 target。

欄位

此關係連線的讀取操作將傳回 JSON 格式的結果：

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

data

LiveVideo 欄位清單。

paging

若要進一步了解分頁，請參閱 Graph API 指南。

驗證規則

錯誤	說明
200	權限錯誤

更新

您無法在此端點上執行此操作。

刪除

您無法在此端點上執行此操作。