Class ChatmanApi

Namespace

Twikit.Spaces

Assembly

Twikit.dll

chatman コントロールプレーン（guest-cf.pscp.tv の /api/v1）のクライアント。 すべてのリクエストは proxsee authorizeToken（service=guest）で得たトークンで認証され、 ボディにスペースのチャットトークンを持ちます。

public sealed class ChatmanApi

Inheritance

object

ChatmanApi

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ChatmanApi(Client)

public ChatmanApi(Client client)

Parameters

client Client

Methods

AddAdminAsync(string, string)

public Task<JsonObject> AddAdminAsync(string broadcastId, string twitterUserId)

Parameters

broadcastId string

twitterUserId string

Returns

Task<JsonObject>

AdminInviteAsync(string, IEnumerable<string>, string)

管理者（ホスト/共同ホスト）を chatman のルームに登録します。Web クライアントは publishBroadcast の直後に ホスト自身の twitter id で呼びます。これがホストを管理者（かつミュート解除）としてリスナーに見せます。

public Task<JsonObject> AdminInviteAsync(string broadcastId, IEnumerable<string> twitterUserIds, string sessionUuid = "")

Parameters

broadcastId string

twitterUserIds IEnumerable<string>

sessionUuid string

Returns

Task<JsonObject>

ApproveRequestAsync(string)

public Task<JsonObject> ApproveRequestAsync(string sessionUuid)

Parameters

sessionUuid string

Returns

Task<JsonObject>

CancelSpeakerRequestAsync(string, string)

public Task<JsonObject> CancelSpeakerRequestAsync(string broadcastId, string sessionUuid)

Parameters

broadcastId string

sessionUuid string

Returns

Task<JsonObject>

EndAudioSpaceAsync(string)

スペース全体を終了します（ホスト/管理者のみ）。

public Task<JsonObject> EndAudioSpaceAsync(string broadcastId)

Parameters

broadcastId string

Returns

Task<JsonObject>

EndStreamAsync(string)

public Task<JsonObject> EndStreamAsync(string sessionUuid)

Parameters

sessionUuid string

Returns

Task<JsonObject>

GetCallStatusAsync(string, bool)

public Task<JsonObject> GetCallStatusAsync(string broadcastId, bool includeNonActiveSessions = true)

Parameters

broadcastId string

includeNonActiveSessions bool

Returns

Task<JsonObject>

InitializeAsync(string?)

public Task InitializeAsync(string? chatAccessToken = null)

Parameters

chatAccessToken string

Returns

Task

JoinAsSpeakerAsync(string, bool, bool)

スピーカーとして参加します。{can_auto_join, session_uuid, ...} を返します。

public Task<JsonObject> JoinAsSpeakerAsync(string broadcastId, bool joinAsAdmin = false, bool shouldAutoJoin = true)

Parameters

broadcastId string

joinAsAdmin bool

shouldAutoJoin bool

Returns

Task<JsonObject>

LowerHandAsync(string, string)

public Task<JsonObject> LowerHandAsync(string sessionUuid, string broadcastId)

Parameters

sessionUuid string

broadcastId string

Returns

Task<JsonObject>

MuteSpaceAsync(string)

public Task<JsonObject> MuteSpaceAsync(string broadcastId)

Parameters

broadcastId string

Returns

Task<JsonObject>

MuteSpeakerAsync(string, string)

public Task<JsonObject> MuteSpeakerAsync(string sessionUuid, string broadcastId)

Parameters

sessionUuid string

broadcastId string

Returns

Task<JsonObject>

NegotiateStreamAsync(string)

Janus の資格情報 {janus_jwt, webrtc_gw_url, ...} を返します。

public Task<JsonObject> NegotiateStreamAsync(string sessionUuid)

Parameters

sessionUuid string

Returns

Task<JsonObject>

PublishStreamAsync(string, JsonObject?)

public Task<JsonObject> PublishStreamAsync(string sessionUuid, JsonObject? extra = null)

Parameters

sessionUuid string

extra JsonObject

Returns

Task<JsonObject>

RaiseHandAsync(string, string, string)

public Task<JsonObject> RaiseHandAsync(string sessionUuid, string broadcastId, string emoji = "✋")

Parameters

sessionUuid string

broadcastId string

emoji string

Returns

Task<JsonObject>

RejectRequestAsync(string)

public Task<JsonObject> RejectRequestAsync(string sessionUuid)

Parameters

sessionUuid string

Returns

Task<JsonObject>

RemoveAdminAsync(string, string, string)

public Task<JsonObject> RemoveAdminAsync(string broadcastId, string sessionUuid, string twitterUserId)

Parameters

broadcastId string

sessionUuid string

twitterUserId string

Returns

Task<JsonObject>

RemoveParticipantAsync(string, IEnumerable<string>)

public Task<JsonObject> RemoveParticipantAsync(string broadcastId, IEnumerable<string> twitterUserIds)

Parameters

broadcastId string

twitterUserIds IEnumerable<string>

Returns

Task<JsonObject>

SetSpaceSettingsAsync(string, int, JsonArray?, JsonArray?)

public Task<JsonObject> SetSpaceSettingsAsync(string broadcastId, int conversationControls = 0, JsonArray? topics = null, JsonArray? mentionedTwitterUserIds = null)

Parameters

broadcastId string

conversationControls int

topics JsonArray

mentionedTwitterUserIds JsonArray

Returns

Task<JsonObject>

StreamEjectAsync(string, long, long, string, long)

Janus の音声ストリームから publisher を追い出します。X は Chatman と Janus の両方の識別子を要求します。

public Task<JsonObject> StreamEjectAsync(string sessionUuid, long webrtcHandleId, long webrtcSessionId, string janusRoomId, long janusParticipantId)

Parameters

sessionUuid string

webrtcHandleId long

webrtcSessionId long

janusRoomId string

janusParticipantId long

Returns

Task<JsonObject>

SubmitSpeakerRequestAsync(string)

public Task<JsonObject> SubmitSpeakerRequestAsync(string broadcastId)

Parameters

broadcastId string

Returns

Task<JsonObject>

UnmuteSpaceAsync(string)

public Task<JsonObject> UnmuteSpaceAsync(string broadcastId)

Parameters

broadcastId string

Returns

Task<JsonObject>

UnmuteSpeakerAsync(string, string)

public Task<JsonObject> UnmuteSpeakerAsync(string sessionUuid, string broadcastId)

Parameters

sessionUuid string

broadcastId string

Returns

Task<JsonObject>