圖形 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 string

直播影片的說明。支援表情符號。

encoding_settings

字串

直播主用於此串流的編碼設定群組識別碼。此參數目前僅用於 live-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

清單<數值字串或整數>

將播送至此直播影片的直播編碼器。

original_fov

int64

相機的原始視野範圍。

post_surfaces_blacklist

清單<列舉{1, 2, 3, 4, 5}>

指定貼文不會出現在哪些地方的黑名單,僅適用於動態消息體驗。

privacy

隱私參數

此直播影片的隱私設定。

projection

列舉{EQUIRECTANGULAR, CUBEMAP}

此標示代表 360 直播串流影片的預期投影方式。預設值為 EQUIRECTANGULAR。

save_vod

布林值

是否應以 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 string

直播影片的標題。支援表情符號。

傳回類型

此端點支援「寫入後讀取」功能,並且會讀取傳回類型中 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 */

若要進一步瞭解圖形 API,請參閱使用圖形 API 指南

參數

名稱說明
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

如需分頁的詳細資訊,請參閱圖形 API 指南

驗證規則

錯誤說明

200

權限錯誤

更新

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

刪除

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