プロジェクト Hisui Cloud API¶

概要¶

プロジェクトの API Key を利用してそのプロジェクトの録画ファイルを Hisui を利用して合成する API です。

Hisui ジョブをキューに送信する¶

API URL:: https://api.sora-cloud.shiguredo.app/projects/submit-hisui-job

録画合成ジョブをキューに送信します。

recording_id
- 必須
profile_id
- オプション
- デフォルトは 0
- 0
  - 映像は H.264
  - 音声は Opus
  - コンテナは MP4
  - 解像度は 720p (1280x720)
  - ビットレートは 1000 Kbps
- 1
  - 映像は VP9
  - 音声は Opus
  - コンテナは MP4
  - 解像度は 1080p (1920x1080)
  - ビットレートは 1500 Kbps
- 2
  - 映像は AV1
  - 音声は Opus
  - コンテナは MP4
  - 解像度は 1080p (1920x1080)
  - ビットレートは 1000 Kbps

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/submit-hisui-job \
    recording_id=<Recording-ID> \
    profile_id:=1 \
    -vvv

POST /projects/submit-hisui-job HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 63
Content-Type: application/json
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0

{
    "recording_id": "0CVR4THQ4938H92ENEGB6RJYGG",
    "profile_id": 1
}

HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json; charset=UTF-8
Content-Length: 370
Date: Fri, 22 Dec 2023 09:18:38 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

{
    "id":"N5DRH87MEH1QD44ME2WVVD7C0G",
    "recording_id":"0CVR4THQ4938H92ENEGB6RJYGG",
    "channel_id":"channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
    "status":"queued",
    "error_code":null,
    "queued_timestamp":"2023-12-22T09:18:38.490066Z",
    "output_audio_codec_type":"Opus",
    "output_audio_bit_rate":64000,
    "output_video_codec_type":"VP9",
    "output_video_bit_rate":1500,
    "recording_duration_s":180
}

管理コンソール¶

この API は管理コンソールから GUI で実行する事ができます。

Hisui ジョブをキャンセルします¶

API URL:: https://api.sora-cloud.shiguredo.app/projects/cancel-hisui-job

録画合成ジョブをキャンセルします。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/cancel-hisui-job \
    hisui_job_id=<Hisui-Job-ID> \
    -vvv

POST /projects/cancel-hisui-job HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 46
Content-Type: application/json
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0

{
    "hisui_job_id": "XM0RX7730D4SVCPS5WGPM6APZ4"
}

HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json; charset=UTF-8
Content-Length: 196
Date: Fri, 22 Dec 2023 09:24:02 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

{
    "id":"XM0RX7730D4SVCPS5WGPM6APZ4",
    "recording_id":"0CVR4THQ4938H92ENEGB6RJYGG",
    "channel_id":"channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
    "status":"waiting",
    "canceled":false,
    "canceled_timestamp":null
}

管理コンソール¶

この API は管理コンソールから GUI で実行する事ができます。

Hisui ジョブ一覧を取得する¶

API URL:: https://api.sora-cloud.shiguredo.app/projects/list-hisui-jobs

録画合成ジョブの一覧を取得します。

直近に登録した 100 件を取得できます。

$ https -A bearer -a <API-KEY> \
    POST api.sora-cloud.shiguredo.app/projects/list-hisui-jobs \
    -vvv

POST /projects/list-hisui-jobs HTTP/1.1
Accept: application/json, */*;q=0.5
Accept-Encoding: gzip, deflate
Authorization: Bearer <API-KEY>
Connection: keep-alive
Content-Length: 0
Host: api.sora-cloud.shiguredo.app
User-Agent: HTTPie/3.2.0



HTTP/1.1 200 OK
Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json; charset=UTF-8
Date: Thu, 21 Dec 2023 09:35:10 GMT
Strict-Transport-Security: max-age=15552000; includeSubDomains; preload
Transfer-Encoding: chunked
Vary: Accept-Encoding
alt-svc: h3=":443"; ma=86400

[
    {
        "id": "8VWEP6MT7S7C7A99NNA5E79THM",
        "status": "failed",
        "recording_id": "2Q29SF936S2T503EDJKSTPM8HW",
        "channel_id": "channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
        "queued_timestamp": "2023-12-22T04:50:31.929676Z",
        "started_timestamp": "2023-12-22T04:50:40.57687Z",
        "canceled_timestamp": null,
        "completed_timestamp": null,
        "failed_timestamp": "2023-12-22T04:50:40.641998Z",
        "output_audio_codec_type": "Opus",
        "output_audio_bit_rate": 64000,
        "output_video_codec_type": "VP9",
        "output_video_bit_rate": 1500,
        "output_container_type": "MP4",
        "canceled": false
    },
    {
        "id": "VY8NZDENCD6JZF0VXWY5RYQ784",
        "status": "failed",
        "recording_id": "2Q29SF936S2T503EDJKSTPM8HW",
        "channel_id": "channel-1@A5J467N5AWTQHFSA2VIKVNGDB2VK2DC9",
        "queued_timestamp": "2023-12-22T07:36:43.27188Z",
        "started_timestamp": "2023-12-22T07:37:10.799462Z",
        "canceled_timestamp": null,
        "completed_timestamp": null,
        "failed_timestamp": "2023-12-22T07:37:10.860303Z",
        "output_audio_codec_type": "Opus",
        "output_audio_bit_rate": 64000,
        "output_video_codec_type": "VP9",
        "output_video_bit_rate": 1500,
        "output_container_type": "MP4",
        "canceled": false
    },
    ...
]

管理コンソール¶

この API は管理コンソールから GUI で実行する事ができます。