Версия API Graph

Видеотрансляции группы

Дополнительную информацию об API Live Video см. на странице с документацией о видеотрансляциях.

Создание

Вы можете отправить запрос POST к границе контекста live_videos с помощью следующих путей:

  • /{group-id}/live_videos

При публикации к этой границе контекста будет создан объект LiveVideo.

Параметры

ИмяОписание
app_attribution_tag

numberic string or integer

Метка атрибуции для видеотрансляций, которая будет отображаться в ленте.

attribution_app_id

numberic string or integer

Id of the attribution app.

content_tags

list<numberic string>

Метки, описывающие контент видео. Чтобы получить возможные ID, используйте конечную точку поиска с type=adinterest. Пример запроса:

/search?type=adinterest&q=sunsets

description

UTF-8 string

Описание видеотрансляции. Поддерживает смайлики.

encoding_settings

string

Идентификатор группы параметров кодирования, который автор трансляции использует для этого потока. В настоящее время этот параметр используется только для видеотрансляции 360°. Значение, которое необходимо передать в этот параметр, является значением ключа identifier предустановки настроек кодирования. Предустановки кодирования можно найти, если отправить запрос к конечной точке API Graph /broadcaster_encoding_settings (запрос GET).

event_params

integer

Метка времени Unix, когда автор видеотрансляции планирует выйти в прямой эфир.

fisheye_video_cropped

boolean

Необходимо или нет обрезать одиночное видео с эффектом рыбьего глаза.

front_z_rotation

float

Значение вращения спереди по оси Z в градусах для одиночного видео с эффектом рыбьего глаза.

game_id

numberic string or integer

Указывает, о какой игре это видео. Чтобы получить возможные ID, используйте конечную точку поиска с type=game. Пример запроса:

/search?type=game&=pubg

game_specs

Game Specs Parameter

Установите метаданные, представляющие, какая игра должна быть привязана.

is_spherical

boolean

Флаг обозначает, что трансляция является прямой видеотрансляцией с 360°.

live_encoders

list<numberic string or integer>

Кодировщики в прямом эфире, которые будут использоваться для этой прямой видеотрансляции.

original_fov

int64

Исходное поле зрения камеры.

post_surfaces_blacklist

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

Черный список мест, в которых публикация не появится, для использования только с лентой.

privacy

Privacy Parameter

Параметр конфиденциальности для этой прямой видеотрансляции.

projection

enum{EQUIRECTANGULAR, CUBEMAP}

Флаг, который обозначает предполагаемую проекцию для видеотрансляций 360°. По умолчанию используется значение EQUIRECTANGULAR.

save_vod

boolean

Следует ли данные видео сохранять для последующего использования в формате видео по запросу. По умолчанию установлено true. (Примечание. Может быть установлено только во время создания)

schedule_custom_profile_image

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

Установите для этого параметра значение true, если поток должен останавливаться при получении команды RTMP deleteStream.

title

UTF-8 string

Название видеотрансляции. Поддерживает смайлики.

Возвращаемый тип

Эта конечная точка поддерживает чтение после записи и будет считывать узел, представленный значением 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 Groups

Для этой функции требуется проверка приложения.

Пример

/* 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 Graph см. в руководстве по использованию API Graph.

Параметры

ИмяОписание
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

Список полей LiveVideo.

paging

Дополнительную информацию о разбивке на страницы см. в руководстве по API Graph.

Правила проверки

ОшибкаОписание

200

Ошибка разрешений

Обновление

Эта операция не поддерживается для данной конечной точки.

Удаление

Эта операция не поддерживается для данной конечной точки.