廃止 API

概要

廃止 API とはすでに廃止された API です。

廃止 シグナリング API

廃止 API: 指定したチャネルすべての配信者の接続を切断する

廃止

2021 年 6 月リリースの Sora にて廃止

代替 API

20201013.DisconnectChannelByRole

サービス

Sora

バージョン

20151104

オペレーション

DisconnectChannelUpstream

x-sora-target

Sora_20151104.DisconnectChannelUpstream

キー

channel_id

string

reason (オプション)

object

reason に値を指定した場合、イベントウェブフック connection.destroyedreason に指定した値が入ってきます。

$ http POST 127.0.0.1:3000 \
    x-sora-target:Sora_20151104.DisconnectChannelUpstream \
    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.3
x-sora-target: Sora_20151104.DisconnectChannelUpstream

{
    "channel_id": "sora"
}

HTTP/1.1 200 OK
content-length: 0
content-type: application/json
date: Sun, 24 Jul 2016 06:04:53 GMT
server: Cowboy

廃止 API: 指定したチャネルすべての視聴者の接続を切断する

廃止

2021 年 6 月リリースの Sora にて廃止

代替 API

20201013.DisconnectChannelByRole

サービス

Sora

バージョン

20151104

オペレーション

DisconnectChannelDownstream

x-sora-target

Sora_20151104.DisconnectChannelDownstream

キー

channel_id

string

reason (オプション)

object

reason に値を指定した場合、イベントウェブフック connection.destroyed の reason に指定した値が入ってきます。

$ http POST 127.0.0.1:3000 \
    x-sora-target:Sora_20151104.DisconnectChannelDownstream \
    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.3
x-sora-target: Sora_20151104.DisconnectChannelDownstream

{
    "channel_id": "sora"
}

HTTP/1.1 200 OK
content-length: 0
content-type: application/json
date: Sun, 24 Jul 2016 06:04:53 GMT
server: Cowboy

廃止 API: 指定したクライアント ID の接続を切断する

警告

sora.conf にて allow_client_id_assignment を true にしていた場合はこの API は利用できません

廃止日

2021 年 6 月リリースの Sora にて廃止

代替 API

Sora_20151104.DisconnectClient

サービス

Sora

バージョン

20151104

オペレーション

Disconnect

x-sora-target

Sora_20151104.Disconnect

キー

channel_id

string

client_id

string

reason (オプション)

object

reason に値を指定した場合、イベントウェブフック connection.destroyed の reason に指定した値が入ってきます。

$ http POST 127.0.0.1:3000/ \
    x-sora-target:Sora_20151104.Disconnect \
    channel_id=sora \
    client_id=HMRVPQEXJX03D3B3WE778SJGRC \
    -vvv
POST / HTTP/1.1
Accept: application/json
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 75
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/0.9.3
x-sora-target: Sora_20151104.Disconnect

{
    "channel_id": "sora",
    "client_id": "HMRVPQEXJX03D3B3WE778SJGRC"
}

HTTP/1.1 200 OK
content-length: 0
content-type: application/json
date: Sun, 29 May 2020 05:13:20 GMT
server: Cowboy

廃止 API: 指定したチャネルの接続一覧を取得する

廃止日

2021 年 6 月リリースの Sora にて廃止

代替 API

Sora_20201013.ListChannelConnections

サービス

Sora

バージョン

20151104

オペレーション

ListConnections

x-sora-target

Sora_20151104.ListConnections

キー

channel_id

string

$ http POST 127.0.0.1:3000/ \
    x-sora-target:Sora_20151104.ListConnections \
    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/2.0.0
x-sora-target: Sora_20151104.ListConnections

{
    "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: 361
content-type: application/json
date: Fri, 12 Jun 2020 06:37:58 GMT
server: Cowboy

[
    {
        "channel_id": "sora",
        "client_id": "6DXMKHX8Q106K9YKN693C2D69C",
        "connection_id": "6DXMKHX8Q106K9YKN693C2D69C",
        "multistream": true,
        "role": "sendrecv",
        "simulcast": true,
        "spotlight": false
    },
    {
        "channel_id": "sora",
        "client_id": "QR3H6TYEA907B2HRDF6KCBGWYG",
        "connection_id": "QR3H6TYEA907B2HRDF6KCBGWYG",
        "multistream": true,
        "role": "sendrecv",
        "simulcast": true,
        "spotlight": false
    }
]

廃止 サイマルキャスト API

廃止 API: 指定した参加者の視聴する映像の画質を変更する

廃止

2021 年 6 月リリースの Sora にて廃止

代替 API

Sora_20201005.RequestRtpStream

サービス

Sora

バージョン

20180820

オペレーション

ChangeSimulcastQuality

x-sora-target

Sora_20180820.ChangeSimulcastQuality

キー

channel_id

string

connection_id

string

stream_id (オプション)

string

quality

string (high | middle | low)

$ http POST 127.0.0.1:3000/ \
    x-sora-target:Sora_20180820.ChangeSimulcastQuality \
    channel_id=sora \
    connection_id=KD9N57E2RN5T1BDEA7S7SH038M \
    quality=high \
    -vvv
POST / HTTP/1.1
Accept: application/json, */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 98
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/1.0.2
x-sora-target: Sora_20180820.ChangeSimulcastQuality

{
    "channel_id": "sora",
    "connection_id": "KD9N57E2RN5T1BDEA7S7SH038M",
    "quality": "high"
}

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: 93
content-type: application/json
date: Thu, 04 Apr 2019 05:36:44 GMT
server: Cowboy

{
    "channel_id": "sora",
    "connection_id": "KD9N57E2RN5T1BDEA7S7SH038M",
    "quality": "high"
}

廃止 統計 API

旧 API: 指定したクライアントの統計情報を取得する

廃止

2021 年 6 月リリースの Sora にて廃止

警告

sora.conf にて allow_client_id_assignment を true にしていた場合はこの API は利用できません

サービス

Sora

バージョン

20170529

オペレーション

GetStats

x-sora-target

Sora_20170529.GetStats

キー

channel_id

string

client_id

string

$ http POST 127.0.0.1:3000/ \
    x-sora-target:Sora_20170529.GetStats \
    channel_id=sora \
    client_id=WZXPMM6K8113K83VB8G9XZDTFW -vvv

POST / HTTP/1.1
Accept: application/json, */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 65
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/2.0.0
x-sora-target: Sora_20170529.GetStats

{
    "channel_id": "sora",
    "client_id": "WZXPMM6K8113K83VB8G9XZDTFW"
}

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: 2770
content-type: application/json
date: Tue, 09 Jun 2020 05:42:39 GMT
server: Cowboy

{
    "channel_id": "sora",
    "client_id": "WZXPMM6K8113K83VB8G9XZDTFW",
    "connection_id": "WZXPMM6K8113K83VB8G9XZDTFW",
    "dtls": {
        "total_received_dtls": 2,
        "total_sent_dtls": 2
    },
    "network_status": {
        "unstable_level": 0
    },
    "packet_loss_simulator": {
        "total_dropped_received_rtp": 0,
        "total_dropped_sent_rtp": 0
    },
    "rtp": {
        "total_generic_nack_cache_hit": 0,
        "total_generic_nack_cache_miss": 0,
        "total_pli_trigger": 0,
        "total_received": 1105,
        "total_received_byte_size": 845972,
        "total_received_rtcp": 20,
        "total_received_rtcp_bye": 0,
        "total_received_rtcp_byte_size": 1304,
        "total_received_rtcp_psfb_afb": 0,
        "total_received_rtcp_psfb_fir": 0,
        "total_received_rtcp_psfb_pli": 0,
        "total_received_rtcp_rr": 2,
        "total_received_rtcp_rtpfb_generic_nack": 0,
        "total_received_rtcp_rtpfb_tmmbn": 0,
        "total_received_rtcp_rtpfb_tmmbr": 0,
        "total_received_rtcp_rtpfb_transport_wide": 0,
        "total_received_rtcp_sdes": 18,
        "total_received_rtcp_sr": 18,
        "total_received_rtcp_unknown": 0,
        "total_received_rtcp_xr": 0,
        "total_received_rtp": 1085,
        "total_received_rtp_byte_size": 844668,
        "total_received_rtp_red": 0,
        "total_received_rtp_red_rtx": 0,
        "total_received_rtp_red_ulpfec": 0,
        "total_received_rtp_rtx": 0,
        "total_sent": 9,
        "total_sent_byte_size": 606,
        "total_sent_rtcp": 9,
        "total_sent_rtcp_bye": 0,
        "total_sent_rtcp_byte_size": 606,
        "total_sent_rtcp_psfb_afb": 8,
        "total_sent_rtcp_psfb_fir": 0,
        "total_sent_rtcp_psfb_pli": 0,
        "total_sent_rtcp_rr": 9,
        "total_sent_rtcp_rtpfb_generic_nack": 0,
        "total_sent_rtcp_rtpfb_tmmbn": 0,
        "total_sent_rtcp_rtpfb_tmmbr": 0,
        "total_sent_rtcp_rtpfb_transport_wide": 0,
        "total_sent_rtcp_sdes": 0,
        "total_sent_rtcp_sr": 0,
        "total_sent_rtcp_unknown": 0,
        "total_sent_rtcp_xr": 0,
        "total_sent_rtp": 0,
        "total_sent_rtp_byte_size": 0
    },
    "timestamp": "2020-06-09T05:42:40Z",
    "turn": {
        "total_received_allocate_request": 11,
        "total_received_binding_request": 0,
        "total_received_channel_bind_request": 1,
        "total_received_channel_data": 1113,
        "total_received_create_permission_request": 2,
        "total_received_expired_channel_number": 0,
        "total_received_refresh_request": 0,
        "total_received_send_indication": 7,
        "total_received_turn_binding_error": 0,
        "total_received_turn_binding_request": 7,
        "total_received_turn_binding_success": 6,
        "total_received_turn_invalid_stun": 0,
        "total_received_turn_unknown": 0,
        "total_received_turn_unknown_stun": 0,
        "total_received_unknown_channel_number": 0,
        "total_sent_allocate_error": 7,
        "total_sent_allocate_success": 2,
        "total_sent_binding_error": 0,
        "total_sent_binding_success": 0,
        "total_sent_channel_bind_error": 0,
        "total_sent_channel_bind_success": 1,
        "total_sent_channel_data": 19,
        "total_sent_create_permission_error": 0,
        "total_sent_create_permission_success": 2,
        "total_sent_data_indication": 5,
        "total_sent_refresh_error": 0,
        "total_sent_refresh_success": 0,
        "total_sent_turn_binding_error": 0,
        "total_sent_turn_binding_request": 6,
        "total_sent_turn_binding_success": 2,
        "total_sent_turn_unknown": 0
    }
}

廃止 プッシュ API

廃止 API: 指定したチャネルの配信クライアントにプッシュ通知を送る

廃止

2021 年 6 月リリースの Sora にて廃止

代替 API

Sora_20201120.PushChannelByRole

サービス

Sora

バージョン

20160711

オペレーション

PushUpstream

x-sora-target

Sora_20160711.PushUpstream

キー

channel_id

string

data

object

$ http POST 127.0.0.1:3000/ \
    x-sora-target:Sora_20160711.PushUpstream \
    channel_id=sora \
    data:="{\"spam\": \"egg\"}" \
    -vvv
POST / HTTP/1.1
Accept: application/json
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 47
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/0.9.4
x-sora-target: Sora_20160711.PushUpstream

{
    "channel_id": "sora",
    "data": {
        "spam": "egg"
    }
}

HTTP/1.1 200 OK
t-length: 37
content-type: application/json
date: Sun, 24 Jul 2016 06:29:08 GMT
server: Cowboy

{
    "data": {
        "spam": "egg"
    },
    "type": "push"
}

廃止 API: 指定したチャネルの視聴クライアントにプッシュ通知を送る

廃止

2021 年 6 月リリースの Sora にて廃止

代替 API

Sora_20201120.PushChannelByRole

サービス

Sora

バージョン

20160711

オペレーション

PushDownstream

x-sora-target

Sora_20160711.PushDownstream

キー

channel_id

string

data

object

$ http POST 127.0.0.1:3000/ \
    x-sora-target:Sora_20160711.PushDownstream \
    channel_id=sora \
    data:="{\"spam\": \"egg\"}" \
    -vvv
POST / HTTP/1.1
Accept: application/json
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 47
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/0.9.4
x-sora-target: Sora_20160711.PushDownstream

{
    "channel_id": "sora",
    "data": {
        "spam": "egg"
    }
}

HTTP/1.1 200 OK
content-length: 37
content-type: application/json
date: Sun, 24 Jul 2016 06:29:20 GMT
server: Cowboy

{
    "data": {
        "spam": "egg"
    },
    "type": "push"
}

廃止 スポットライト API

指定した参加者の受信している映像ストリームのクオリティを変更する

廃止

2020 年 12 月リリースの Sora にて廃止

代替 API

Sora_20201005.RequestRtpStream

サービス

Sora

バージョン

20200807

オペレーション

RequestSpotlightQuality

x-sora-target

Sora_20200807.RequestSpotlightQuality

スポットライトのフォーカスとは別に、画質を受信ストリームすべて、またはストリームごと変更可能です。 現時点では low か middle のみ指定可能です。

キー

channel_id

string

connection_id

string

stream_id (オプション)

string

quality

string (low / middle / high)

$ http POST 127.0.0.1:3000/ x-sora-target:Sora_20200807.RequestSpotlightQuality \
    channel_id=sora connection_id=DRPBMP6FEH49S5CSB04EDSTQ38 quality=low -vvv
POST / HTTP/1.1
Accept: application/json, */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 87
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/2.0.0
x-sora-target: Sora_20200807.RequestSpotlightQuality

{
    "channel_id": "sora",
    "connection_id": "DRPBMP6FEH49S5CSB04EDSTQ38",
    "quality": "low"
}

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, 09 Sep 2020 08:47:49 GMT
server: Cowboy

{
    "channel_id": "sora",
    "connection_id": "DRPBMP6FEH49S5CSB04EDSTQ38",
    "quality": "low"
}

指定した参加者の受信している映像ストリームのクオリティをリセットする

廃止

2020 年 12 月リリースの Sora にて廃止

代替 API

Sora_20201005.ResetRtpStream

サービス

Sora

バージョン

20200807

オペレーション

ResetSpotlightQuality

x-sora-target

Sora_20200807.ResetSpotlightQuality

RequestSpotlightQuality で変更された画質をリセットします。

キー

channel_id

string

connection_id

string

stream_id (オプション)

string

$ http POST 127.0.0.1:3000/ x-sora-target:Sora_20200807.ResetSpotlightQuality \
    channel_id=sora connection_id=DRPBMP6FEH49S5CSB04EDSTQ38 -vvv
POST / HTTP/1.1
Accept: application/json, */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Content-Length: 69
Content-Type: application/json
Host: 127.0.0.1:3000
User-Agent: HTTPie/2.0.0
x-sora-target: Sora_20200807.ResetSpotlightQuality

{
    "channel_id": "sora",
    "connection_id": "DRPBMP6FEH49S5CSB04EDSTQ38"
}

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: 66
content-type: application/json
date: Wed, 09 Sep 2020 08:48:35 GMT
server: Cowboy

{
    "channel_id": "sora",
    "connection_id": "DRPBMP6FEH49S5CSB04EDSTQ38"
}
© Copyright 2021, Shiguredo Inc Created using Sphinx 4.2.0