API docs by Redocly

RICOH Live Streaming REST API: 録画 API (v1)

Download OpenAPI specification:Download

RICOH Live Streaming REST API は Live Streaming サービスの公開 REST API です。

本ページは録画 API の仕様について記載します。

録画機能について

クラウド録画機能 は、現在 β 版として提供しております。
そのため、商用サービスでの利用をご検討される際には、必ず事前にお問い合わせください。
β 版のクラウド録画機能の利用料金は無料です。正式版は有償での提供を検討しておりますので、あらかじめご了承ください。
正式版を公開せずに β 版の公開を終了する、もしくは、正式版では β 版から機能や仕様が変更される可能性がありますので、あらかじめご了承ください。
クラウド録画機能に関連して現在発生している問題はRICOH Live Streaming クラウド既知の問題を確認してください。

録画の設定について

RoomInstance に対する録画を行うには、AccessToken の設定を利用した録画の制御を利用します。

また、録画データの保存先として、事前に本ページの 録画ストレージ設定 API を利用してお客様の管理するクラウドストレージを設定しておく必要があります。

お客様ストレージに保存する場合のディレクトリ構成仕様

お客様のストレージに録画データを保存することを指定した場合、保存先に指定されたURLから以下のようなパスで単一拠点録画ファイルと単一拠点メタデータファイルがセットで保存されます。
また、録画データの合成を指定した場合、対象となる単一拠点録画ファイルを合成して1つにした合成録画ファイルと合成録画メタデータファイルも併せて保存します。

  • 単一拠点録画ファイル
    • パス: /{room_id}/{RoomInstanceの開始時刻}/{Sequence}/{connection_id}-{ConnectionInstanceの録画開始時刻}-{ConnectionInstanceの録画終了時刻}.mp4
  • 単一拠点録画メタデータファイル
    • パス: /{room_id}/{RoomInstanceの開始時刻}/{Sequence}/{connection_id}-{ConnectionInstanceの録画開始時刻}-{ConnectionInstanceの録画終了時刻}.json
    • 本ページの ConnectionRecordingMetadata のスキーマを持つ JSON 形式
  • 合成録画ファイル
    • パス: /{room_id}/{RoomInstanceの開始時刻}/{Sequence}/compositions/{RoomInstanceの録画開始時刻}-{RoomInstanceの録画終了時刻}.mp4
  • 合成録画メタデータファイル
    • パス: /{room_id}/{RoomInstanceの開始時刻}/{Sequence}/compositions/{RoomInstanceの録画開始時刻}-{RoomInstanceの録画終了時刻}.json
    • 本ページの CompositionRecordingMetadata のスキーマを持つ JSON 形式
  • 開始時刻、録画開始時刻、および録画終了時刻 は UTC で yyyyMMddhhmmss の形式になります
  • Sequence は、1つの RoomInstance の生存期間中に行った録画の通し番号です
    • 1 から始まり、録画を開始する度にインクリメントされます
    • 現状は AccessToken の recording_on_start 設定による RoomInstance 全体の録画のみ可能ですが、今後 REST API による任意のタイミングでの録画の開始/停止に対応予定です

    • 共通仕様

    • API の認証/認可に失敗した場合、ステータスコード 401 のレスポンスが返却されます

録画ストレージ設定 API

AWS S3 録画ストレージ設定登録

  • レスポンスボディからsecret_access_keyフィールドは取り除かれます
  • すでに録画ストレージ設定が登録済みだった場合、既存の設定は上書きされます
Authorizations:
ClientBasic
path Parameters
client_id
required
string
  • Client ID
Request Body schema: application/json

AWS S3 の録画ストレージ設定を更新するための AwsS3RecordingStorageConfig オブジェクト

s3_url
required
string <= 255 characters
  • 録画ファイルを保存するための S3 バケットの仮想ホスティング URL
  • バケットの仮想ホスティングについては以下のドキュメントを参照のこと
  • URL のスタイルとして、仮想ホスティング形式を利用すること
    • https://<bucket-name>.s3.<region>.amazonaws.com/<key-name>
access_key_id
required
string
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "DenyAll",
            "Effect": "Deny",
            "NotAction": "*",
            "Resource": "*"
        },
        {
            "Sid": "AllowS3Upload",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:AbortMultipartUpload"
            ],
            "Resource": [
                "arn:aws:s3:::<bucket-name>/<key-name>*"
            ]
        }
    ]
}
secret_access_key
required
string
  • S3 バケットにアクセスするための IAM ユーザのシークレットアクセスキー
  • アクセスキーと共に生成されたシークレット

Responses

Request samples

Content type
application/json
{
  • "s3_url": "string",
  • "access_key_id": "string",
  • "secret_access_key": "string"
}

Response samples

Content type
application/json
{
  • "s3_url": "string",
  • "access_key_id": "string",
  • "secret_access_key": "string"
}

AWS S3 録画ストレージ設定取得

レスポンスボディからsecret_access_keyフィールドは取り除かれます

Authorizations:
ClientBasic
path Parameters
client_id
required
string
  • Client ID

Responses

Response samples

Content type
application/json
{
  • "s3_url": "string",
  • "access_key_id": "string",
  • "secret_access_key": "string"
}

AWS S3 録画ストレージ設定リセット

Authorizations:
ClientBasic
path Parameters
client_id
required
string
  • Client ID

Responses

AwsS3RecordingStorageConfig

s3_url
required
string <= 255 characters
  • 録画ファイルを保存するための S3 バケットの仮想ホスティング URL
  • バケットの仮想ホスティングについては以下のドキュメントを参照のこと
  • URL のスタイルとして、仮想ホスティング形式を利用すること
    • https://<bucket-name>.s3.<region>.amazonaws.com/<key-name>
access_key_id
required
string
{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Sid": "DenyAll",
            "Effect": "Deny",
            "NotAction": "*",
            "Resource": "*"
        },
        {
            "Sid": "AllowS3Upload",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:AbortMultipartUpload"
            ],
            "Resource": [
                "arn:aws:s3:::<bucket-name>/<key-name>*"
            ]
        }
    ]
}
secret_access_key
required
string
  • S3 バケットにアクセスするための IAM ユーザのシークレットアクセスキー
  • アクセスキーと共に生成されたシークレット
{
  • "s3_url": "string",
  • "access_key_id": "string",
  • "secret_access_key": "string"
}

ConnectionRecordingMetadata

room_id
required
string <IDString>

Room の ID

recording_id
required
string

Recording の ID

connection_id
required
string <IDString>

Connection の ID

started_at
required
string <date-time>

録画開始時刻(ISO8601)

ended_at
required
string <date-time>

録画終了時刻(ISO8601)

format
required
string
Value: "mp4"

メディアファイルのフォーマット

object (ConnectionRecordingVideoMetadata)

録画の映像データに関するメタデータ

object (RecordingAudioMetadata)

録画の音声データに関するメタデータ

{
  • "room_id": "string",
  • "recording_id": "string",
  • "connection_id": "string",
  • "started_at": "2019-08-24T14:15:22Z",
  • "ended_at": "2019-08-24T14:15:22Z",
  • "format": "mp4",
  • "video": {
    },
  • "audio": {
    }
}

CompositionRecordingMetadata

room_id
required
string <IDString>

Room の ID

recording_id
required
string

Recording の ID

required
Array of objects (ConnectionMetadata)

合成録画に含まれる ConnectionMetadata の配列

started_at
required
string <date-time>

録画開始時刻(ISO8601)

ended_at
required
string <date-time>

録画終了時刻(ISO8601)

format
required
string
Value: "mp4"

メディアファイルのフォーマット

object (CompositionRecordingVideoMetadata)

録画の映像データに関するメタデータ

object (RecordingAudioMetadata)

録画の音声データに関するメタデータ

{
  • "room_id": "string",
  • "recording_id": "string",
  • "connections": [
    ],
  • "started_at": "2019-08-24T14:15:22Z",
  • "ended_at": "2019-08-24T14:15:22Z",
  • "format": "mp4",
  • "video": {
    },
  • "audio": {
    }
}

IDString

string (IDString) ^[a-zA-Z0-9.%+^_"`{|}~<>\\\\-]{1,255}$
  • 1 文字以上 255 文字以下
  • ASCII
  • 以下の文字のみ許可
    • 英数字
    • 次の記号: .%+^_"`{|}~<>\-
"string"