Graph API-Version

Gruppen-Live-Videos

Weitere Informationen zur Live Video API findest du in unserer Dokumentation zu Live-Videos.

Erstellen

Du kannst eine POST-Anfrage mit den folgenden Pfaden an die live_videos-Edge senden:

  • /{group-id}/live_videos

Durch einen Post an diese Edge wird ein LiveVideo erstellt.

Parameter

NameBeschreibung
app_attribution_tag

Numerischer String oder Ganzzahl

Ein Attributions-Tag für Live-Videos, die im Feed angezeigt werden.

attribution_app_id

Numerischer String oder Ganzzahl

ID der Attributions-App.

content_tags

list<numerischer String>

Tags, die den Inhalt des Videos beschreiben. Verwende den Suchendpunkt mit type=adinterest, um mögliche IDs abzurufen. Beispielabfrage:

/search?type=adinterest&q=sunsets

description

UTF-8-String

Die Beschreibung des Live-Videos. Unterstützt Emojis.

encoding_settings

String

ID der Codierungseinstellungsgruppe, die der Broadcaster für diesen Stream verwendet. Dieser Parameter wird derzeit nur für Live-360°-Broadcasts verwendet. Der Wert des identifier-Schlüssels der voreingestellten Codierungseinstellungen muss für diesen Parameter übergeben werden. Die Codierungsvoreinstellungen kannst du über den /broadcaster_encoding_settings Graph API-Endpunkt abfragen (GET-Abfrage).

event_params

Integer

Unix-Zeitstempel für den geplanten Start der Live-Übertragung.

fisheye_video_cropped

Boolescher Wert

Gibt an, ob das einzelne mit Fischaugenobjektiv aufgenommene Video zugeschnitten wurde oder nicht.

front_z_rotation

Gleitkommazahl

Die vordere Z-Rotation des einzelnen mit Fischaugenobjektiv aufgenommenen Videos in Grad.

game_id

Numerischer String oder Ganzzahl

Gibt an, zu welchem Spiel dieses Video gehört. Verwende den Suchendpunkt mit type=game, um mögliche IDs abzurufen. Beispielabfrage:

/search?type=game&=pubg

game_specs

Spielspezifikations-Parameter

Legt Metadaten für das zuzuordnende Spiel fest.

is_spherical

Boolescher Wert

Flag, das angibt, dass der Broadcast ein 360°-Live-Broadcast ist.

live_encoders

list<numerischer String oder Ganzzahl>

Live-Encoder für den Broadcast in diesem Live-Video.

original_fov

int64

Originalsichtfeld der Kamera.

post_surfaces_blacklist

list<enum{1, 2, 3, 4, 5}>

Eine Negativliste von Orten, an denen der Post nicht angezeigt wird, wenn das Erlebnis nur im Feed erscheinen soll.

privacy

Datenschutzparameter

Datenschutz für dieses Live-Video.

projection

enum{EQUIRECTANGULAR, CUBEMAP}

Flag, das die erwartete Projektion für 360°-Livestreams angibt. Der Standardwert lautet „EQUIRECTANGULAR“.

save_vod

Boolescher Wert

Gibt an, ob die Videodaten für die spätere Anzeige im VOD-Format gespeichert werden sollen. Der Standardwert lautet „true“. (Hinweis: Kann nur bei der Erstellung festgelegt werden.)

schedule_custom_profile_image

image

Benutzerdefiniertes Bild, das in der geplanten Live-Story und in der Lobby angezeigt wird.

spatial_audio_format

enum{ambiX_4}

Gibt das Format des räumlichen Audiostreams an. Wenn du diesen Parameter nicht angibst, wird von Mono oder Stereo ausgegangen.

status

enum {UNPUBLISHED, LIVE_NOW, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_CANCELED}

Der Status der Übertragung. Eine LIVE_NOW-Übertragung ist jetzt gerade live und für Nutzer sichtbar. Eine UNPUBLISHED-Übertragung wird vorbereitet und ist noch nicht für andere Nutzer sichtbar. Eine nicht veröffentlichte Übertragung kann nach mehreren Stunden in diesem Status automatisch gelöscht werden. Verwende am besten die SCHEDULED-Statuswerte, um eine geplante, zukünftige Übertragung zu erstellen.

stereoscopic_mode

enum {MONO, LEFT_RIGHT, TOP_BOTTOM}

Setze dieses Flag für dieses Video auf den stereoskopischen Modus.

stop_on_delete_stream

Setze diesen Parameter auf true, wenn der Stream gestoppt werden soll, sobald der deleteStream-RTMP-Befehl empfangen wird.

title

UTF-8-String

Der Titel des Live-Videos. Unterstützt Emojis.

Rückgabetyp

Dieser Endpunkt unterstützt Read-After-Write (Lesen nach Schreiben) und liest den von id dargestellten Node im Rückgabetyp.

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, }

Validierungsregeln

FehlerBeschreibung

100

Ungültiger Parameter

200

Berechtigungsfehler

Lesen

Funktionen

NameBeschreibung

Groups API

Für diese Funktion ist ein App Review erforderlich.

Beispiel

/* 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 */

Mehr über die Graph API erfährst du in unserem Leitfaden zur Verwendung der Graph API.

Parameter

NameBeschreibung
broadcast_status

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

Damit kannst du angeben, welche Arten von Live-Videos zurückgegeben werden. Wenn du keinen Wert angibst, werden alle Statustypen zurückgegeben.

source

enum{target, owner}

Standardwert: target

Die Quelle, in der die Videos abgefragt werden sollen. Beispiel: target ruft an eine Gruppe übertragene Videos ab. Bei Gruppen-Live-Videos wird NUR target unterstützt.

Felder

Beim Lesen von dieser Edge wird ein mit JSON formatiertes Ergebnis zurückgegeben:

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

Eine Liste der LiveVideo-Felder.

paging

Weitere Informationen zur Paginierung findest du im Graph API-Leitfaden.

Validierungsregeln

FehlerBeschreibung

200

Berechtigungsfehler

Aktualisieren

Diesen Vorgang kannst du nicht für diesen Endpunkt ausführen.

Löschen

Diesen Vorgang kannst du nicht für diesen Endpunkt ausführen.