RICOH Live Streaming REST API: Room管理 API (v1)

Download OpenAPI specification:Download

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

本ページは Room 管理 API の仕様について記載します。

共通仕様

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

Room 管理 API

Room情報の取得

パラメータで指定したclient_idとroom_idに一致するRoom情報を返します
Room の type が "p2p" または "p2p_turn" の時は、録画に対応しないため recording_status 要素は省略されます

Authorizations:

ClientBasic

path Parameters

client_id required	string Client ID
room_id required	string Room ID

query Parameters

env	string (LSEnv) Enum: "prod" "dev" 操作対象の環境。複数指定不可

Responses

Response samples

200
404

Content type

application/json

{"client_id": "string",
"room_id": "string",
"room_spec": {"type": "sfu",
"max_connections": 1,
"media_control": {"bitrate_reservation_mbps": 10
},
"recording": {"recording_on_start": false,
"composition_recording": {"enabled": false,
"format": "mp4",
"video": {"resolution": "auto",
"max_bitrate_kbps": "auto"
},
"audio": {"codec": "aac"
}
}
},
"classification_label": "default"
},
"connections": [{"connection_id": "string",
"meta": { }
}
],
"recording_status": {"in_recording": true
}
}

Room強制終了

Roomに入室していたConnectionを全て切断させてRoomを強制的に終了します
Roomに入室していたConnectionのClientSDKは53002 ConnectionClosedByApplicationでクローズします

Authorizations:

ClientBasic

path Parameters

client_id required	string Client ID
room_id required	string Room ID

query Parameters

env	string (LSEnv) Enum: "prod" "dev" 操作対象の環境。複数指定不可

Responses

Response samples

404

Content type

application/json

{"error_id": "not_found",
"message": "string",
"options": { }
}

Connection強制退室

ConnectionをRoomから退室させます
対象ConnectionのClientSDKは53002 ConnectionClosedByApplicationでクローズします

Authorizations:

ClientBasic

path Parameters

client_id required	string Client ID
room_id required	string Room ID
connection_id required	string Connection ID

query Parameters

env	string (LSEnv) Enum: "prod" "dev" 操作対象の環境。複数指定不可

Responses

Response samples

404

Content type

application/json

{"error_id": "not_found",
"message": "string",
"options": { }
}

RoomInfo

client_id required	string parameterで指定したclient_id
room_id required	string <IDString> parameterで指定したroom_id
required	object (RoomSpec) 入室する Room の仕様同時に同じ Room に入室する Connection は同じ RoomSpec が指定されていなければなりません
required	Array of objects (Connection)
	object (RecordingStatus) Roomの録画に関する状態を格納するオブジェクト

{"client_id": "string",
"room_id": "string",
"room_spec": {"type": "sfu",
"max_connections": 1,
"media_control": {"bitrate_reservation_mbps": 10
},
"recording": {"recording_on_start": false,
"composition_recording": {"enabled": false,
"format": "mp4",
"video": {"resolution": "auto",
"max_bitrate_kbps": "auto"
},
"audio": {"codec": "aac"
}
}
},
"classification_label": "default"
},
"connections": [{"connection_id": "string",
"meta": { }
}
],
"recording_status": {"in_recording": true
}
}

IDString

string (IDString) ^[a-zA-Z0-9.%+^_"`{|}~<>\\\\-]{1,255}$

1 文字以上 255 文字以下
ASCII
以下の文字のみ許可
- 英数字
- 次の記号: .%+^_"`{|}~<>\-

"string"