録画 (セッション単位) API¶

録画されたファイルは sora.conf の archive_dir に指定したディレクトリに置かれます。

StartRecording¶

x-sora-target:: Sora_20231220.StartRecording

指定したチャネルの録画を開始します。

クラスター機能利用時には、クラスター内のどのノードで実行しても開始された録画情報はすべてのノードで共有されます。

キー	型
channel_id	string
expire_time (オプション)	integer
split_duration (オプション)	integer
split_only (オプション)	boolean
metadata (オプション)	object

expire_time を指定しない場合は未指定になります
- expire_time を指定しない場合、録画の期限が無くなります
expire_time を指定する範囲は 1 から 86400 までで、秒数を指定してください
- 指定できる最大値はデフォルトで 86400 で recording_max_expire_time に指定した値で変わります
split_only は true か false を指定して下さい。指定しない場合は false が指定されます
split_only を true に指定する場合は split_duration を指定する必要があります
split_duration を指定する範囲は 1 から 86400 までで、秒数を指定して下さい
- 指定できる最大値はデフォルトで 86400 で、 recording_max_split_duration に指定した値で変わります
metadata は JSON オブジェクトを指定してください
- この metadata は recording.report ウェブフックやレポートファイルに recording_metadata として含まれるようになります。

一括録画を行いたい場合¶

split_only を false に指定するか、未指定にしてください

分割録画を行いたい場合¶

split_only を true に指定してください
split_duration を指定してください

一括＆分割録画を行いたい場合¶

sora.conf の recording_dual_output を true に指定してください
split_only を false に指定するか、未指定にしてください
split_duration を指定してください

expire_time が指定無し¶

$ http POST 127.0.0.1:3000/ \
    x-sora-target:Sora_20231220.StartRecording \
    channel_id=sora \
    -vvv
POST / HTTP/1.1
Accept: application/json, */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 41
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/0.9.9
x-sora-target: Sora_20161101.StartRecording

{
    "channel_id": "sora"
}

HTTP/1.1 200 OK
access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, x-sora-target
access-control-allow-methods: POST, OPTIONS
access-control-allow-origin: http://127.0.0.1:5000
access-control-max-age: 1000
content-length: 82
content-type: application/json
date: Wed, 19 Apr 2017 06:35:38 GMT
server: Cowboy

{
    "channel_id": "sora",
    "expire_time": 0,
    "session_id": "96D7CQDEMS5CHCKDX46REWWTX4",
    "recording_id": "C0YTCRZM715BKATBXWFPKTYGRM"
}

expire_time が 3600¶

$ http POST 127.0.0.1:3000/ \
    x-sora-target:Sora_20231220.StartRecording \
    channel_id=sora \
    expire_time:=3600 \
    -vvv
POST / HTTP/1.1
Accept: application/json, */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 43
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/0.9.9
x-sora-target: Sora_20161101.StartRecording

{
    "channel_id": "sora",
    "expire_time": 3600
}

HTTP/1.1 200 OK
access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, x-sora-target
access-control-allow-methods: POST, OPTIONS
access-control-allow-origin: http://127.0.0.1:5000
access-control-max-age: 1000
content-length: 84
content-type: application/json
date: Wed, 19 Apr 2017 06:37:08 GMT
server: Cowboy

{
    "channel_id": "sora",
    "expire_time": 3600,
    "session_id": "96D7CQDEMS5CHCKDX46REWWTX4",
    "recording_id": "C0YTCRZM715BKATBXWFPKTYGRM"
}

split_only が true¶

$ http POST 127.0.0.1:3000/ \
    x-sora-target:Sora_20231220.StartRecording \
    channel_id=sora \
    split_duration:=3600 \
    split_only:=true \
    -vvv

POST / HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 84
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/2.2.0
x-sora-target: Sora_20161101.StartRecording

{
    "channel_id": "sora",
    "split_duration": 3600,
    "split_only": true
}

HTTP/1.1 200 OK
access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, x-sora-target
access-control-allow-methods: POST, OPTIONS
access-control-allow-origin: http://127.0.0.1:5000
access-control-max-age: 1000
content-length: 121
content-type: application/json
date: Fri, 04 Dec 2020 03:04:17 GMT
server: Cowboy

{
    "channel_id": "sora",
    "expire_time": 0,
    "session_id": "96D7CQDEMS5CHCKDX46REWWTX4",
    "recording_id": "MK4J54QBGS4ES0MCSZMF6C9M9M",
    "split_duration": 3600,
    "split_only": true
}

エラー¶

"STARTED-RECORDING"
- 指定したチャネル ID で、すでに録画が開始している
"NOT-CLUSTER-MAJORITY"
- クラスターで半数以下のグループに所属している

$ http POST 127.0.0.1:3000/ \
        x-sora-target:Sora_20231220.StartRecording \
        channel_id=sora \
        expire_time:=3600 \
        -vvv
POST / HTTP/1.1
Accept: application/json, */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 43
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/0.9.9
x-sora-target: Sora_20161101.StartRecording

{
    "channel_id": "sora",
    "expire_time": 3600
}

HTTP/1.1 400 Bad Request
access-control-allow-headers: Origin, X-Requested-With, Content-Type, Accept, x-sora-target
access-control-allow-methods: POST, OPTIONS
access-control-allow-origin: http://127.0.0.1:5000
access-control-max-age: 1000
content-length: 34
content-type: application/json
date: Wed, 19 Apr 2017 06:44:58 GMT
server: Cowboy

{
    "error_type": "STARTED-RECORDING"
}

StopRecording¶

x-sora-target:: Sora_20231220.StopRecording

指定したチャネルの録画を停止します。

この API は非同期です。200 が返ってきた場合でも録画ファイルや録画メタデータファイルが生成されていることを保証しません。イベントウェブフックの archive.available または recording.report の通知を利用してください。

キー	型
channel_id	string

$ http POST 127.0.0.1:3000/ \
    x-sora-target:Sora_20231220.StopRecording \
    channel_id=sora \
    -vvv
POST / HTTP/1.1
Accept: application/json
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 22
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/0.9.4
x-sora-target: Sora_20231220.StopRecording

{
    "channel_id": "sora"
}

HTTP/1.1 200 OK
content-length: 21
content-type: application/json
date: Fri, 11 Nov 2016 14:29:14 GMT
server: Cowboy

{
    "channel_id": "sora",
    "session_id": "96D7CQDEMS5CHCKDX46REWWTX4",
    "recording_id": "C0YTCRZM715BKATBXWFPKTYGRM"
}

エラー¶

NOT-STARTED-RECORDING
- 指定したチャネルの録画が開始されていない
"NOT-CLUSTER-MAJORITY"
- クラスターで半数以下のグループに所属している