Version API du graphe

Vidéos en direct de groupe

Pour plus d’informations sur l’API Live Video, consultez notre documentation sur Live Video.

Création

Vous pouvez envoyer une demande POST à l’arête live_videos à partir des chemins suivants :

  • /{group-id}/live_videos

Une publication sur cette arête crée une vidéo en direct.

Paramètres

NomDescription
app_attribution_tag

chaîne numérique ou nombre entier

Tag d’attribution pour les vidéos en direct qui seront diffusées sur le fil.

attribution_app_id

chaîne numérique ou nombre entier

ID de l’application d’attribution.

content_tags

liste<chaîne numérique>

Tags qui décrivent le contenu de la vidéo. Utilisez le point de terminaison search avec type=adinterest pour obtenir les ID possibles. Exemple de requête :

/search?type=adinterest&q=sunsets

description

chaîne UTF-8

Description de la vidéo en direct. Emojis acceptés.

encoding_settings

chaîne

Identifiant du groupe de paramètres d’encodage utilisé par le diffuseur pour ce stream. Actuellement, ce paramètre est uniquement utilisé pour la diffusion de vidéos 360 en direct. La valeur à transmettre à ce paramètre est la valeur de la clé identifier du préréglage des paramètres d’encodage. Pour obtenir les préréglages d’encodage, interrogez le point de terminaison /broadcaster_encoding_settings de l’API Graph (requête GET).

event_params

nombre entier

Horodatage Unix de la date à laquelle le diffuseur prévoit de passer en direct.

fisheye_video_cropped

Booléen

Indique si la vidéo au format fisheye simple est rognée.

front_z_rotation

nombre à virgule

Rotation avant sur l’axe Z en degrés sur la vidéo au format fisheye simple.

game_id

chaîne numérique ou nombre entier

Indiquez le jeu sur lequel porte cette vidéo. Utilisez le point de terminaison search avec type=game pour obtenir les ID possibles. Exemple de requête :

/search?type=game&=pubg

game_specs

Paramètres des caractéristiques du jeu

Définissez les métadonnées d’attribution du jeu.

is_spherical

Booléen

Indicateur de diffusion d’une vidéo 360 en direct.

live_encoders

liste<chaîne numérique ou entier>

Encodeurs qui diffuseront vers cette vidéo en direct.

original_fov

nombre entier signé 64 bits

Champ de vision original de la caméra.

post_surfaces_blacklist

liste<énumération{1, 2, 3, 4, 5}>

Liste noire des endroits où la publication n’apparaîtra pas, pour tester le flux uniquement.

privacy

Paramètre de confidentialité

Confidentialité de cette vidéo en direct.

projection

énumération{EQUIRECTANGULAR, CUBEMAP}

Indicateur de la projection prévue de streams de vidéos 360 en direct. La valeur par défaut est EQUIRECTANGULAR.

save_vod

Booléen

Indique si les données vidéo doivent être enregistrées pour une consommation ultérieure au format VOD. Par défaut : true. (Remarque : ce paramètre ne peut être défini qu’au moment de la création.)

schedule_custom_profile_image

image

Image personnalisée qui apparaîtra dans la story en direct programmée et dans le lobby.

spatial_audio_format

énumération{ambiX_4}

Spécifie le format du stream audio spatial. Lorsque l’audio n’est pas spécifié, le format supposé est mono ou stéréo.

status

énumération{UNPUBLISHED, LIVE_NOW, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_CANCELED}

Statut de la diffusion. Une diffusion LIVE_NOW est actuellement en direct et visible par les utilisateurs. Une diffusion UNPUBLISHED est en préparation et n’est pas visible par les utilisateurs. Une diffusion non publiée pourra être automatiquement supprimée si cet état reste inchangé pendant plusieurs heures. Pensez à utiliser les états de programmation pour créer une diffusion planifiée.

stereoscopic_mode

énumération{MONO, LEFT_RIGHT, TOP_BOTTOM}

Définissez cet indicateur sur le mode stéréoscopique pour cette vidéo.

stop_on_delete_stream

Définissez ce paramètre sur true si le stream doit être interrompu à la réception de la commande RTMP deleteStream.

title

chaîne UTF-8

Titre de la vidéo en direct. Emojis acceptés.

Type de retour

Ce point de terminaison prend en charge la lecture après écriture et lira le nœud représenté par id dans le type de retour.

Structure { id : chaîne numérique, stream_url : chaîne, secure_stream_url : chaîne, stream_secondary_urls : Liste [ chaîne ], secure_stream_secondary_urls : Liste [ chaîne ], dash_ingest_url: chaîne, }

Règles de validation

ErreurDescription

100

Paramètre non valide

200

Erreur d’autorisation

Lecture

Fonctionnalités

NomDescription

API Groups

Cette fonctionnalité nécessite le Contrôle app.

Exemple

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

Consultez notre Guide d’utilisation de l’API Graph pour en savoir plus.

Paramètres

NomDescription
broadcast_status

liste<énumération{UNPUBLISHED, LIVE, LIVE_STOPPED, PROCESSING, VOD, SCHEDULED_UNPUBLISHED, SCHEDULED_LIVE, SCHEDULED_EXPIRED, SCHEDULED_CANCELED}>

Permet de spécifier le type de retour des vidéos en direct. Si aucune valeur n’est spécifiée, il renvoie tous les types de statuts.

source

énumération{target, owner}

Valeur par défaut : target

Source pour la demande des vidéos. Par exemple, target diffuse les vidéos sur un groupe. Seul target est pris en charge pour les vidéos en direct de groupe.

Champs

La lecture à partir de cette arête renverra un résultat au format JSON :

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

Liste des champs LiveVideo.

paging

Pour plus d’informations sur la pagination, consultez le guide de l’API Graph.

Règles de validation

ErreurDescription

200

Erreur d’autorisation

Mise à jour

Vous ne pouvez pas effectuer cette opération sur ce point de terminaison.

Suppression

Vous ne pouvez pas effectuer cette opération sur ce point de terminaison.