Class IStreamChannel`Abstract`

The IStreamChannel class.

This class provides the stream channel methods that can be invoked by your app.

Hierarchy

IStreamChannel

Index

Constructors

Methods

getChannelName getSubscribedUserList join joinTopic leave leaveTopic publishTopicMessage publishTopicMessageWithBuffer release renewToken subscribeTopic unsubscribeTopic

Constructors

constructor

new IStreamChannel(): IStreamChannel
Returns IStreamChannel

Methods

`Abstract` getChannelName

getChannelName(): string
Return the channel name of this stream channel.

Returns string
The channel name.
- Defined in IAgoraStreamChannel.ts:165

`Abstract` getSubscribedUserList

getSubscribedUserList(topic): UserList[]
Get subscribed user list
Parameters
- topic: string
Returns UserList[]
- 0: Success.
- < 0: Failure.
- Defined in IAgoraStreamChannel.ts:238

`Abstract` join

join(options, requestId?): number
Join the channel.
Parameters
- options: JoinChannelOptions
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraStreamChannel.ts:142

`Abstract` joinTopic

joinTopic(topic, options, requestId?): number
Join a topic.
Parameters
- topic: string
- options: JoinTopicOptions
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraStreamChannel.ts:175

`Abstract` leave

leave(requestId?): number
Leave the channel.
Parameters
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraStreamChannel.ts:159

`Abstract` leaveTopic

leaveTopic(topic, requestId?): number
Leave the topic.
Parameters
- topic: string
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraStreamChannel.ts:205

`Abstract` publishTopicMessage

publishTopicMessage(topic, message, length, option): number
Publish a message in the topic.
Parameters
- topic: string
- message: string
- length: number
- option: TopicMessageOptions
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraStreamChannel.ts:191

`Abstract` publishTopicMessageWithBuffer

publishTopicMessageWithBuffer(topic, message, length, option): number
Parameters
- topic: string
- message: Uint8Array
- length: number
- option: PublishOptions
Returns number
- Defined in IAgoraStreamChannel.ts:247

`Abstract` release

release(): number
Release the stream channel instance.

Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraStreamChannel.ts:246

`Abstract` renewToken

renewToken(token): number
Renews the token. Once a token is enabled and used, it expires after a certain period of time. You should generate a new token on your server, call this method to renew it.
Parameters
- token: string
Returns number
- Defined in IAgoraStreamChannel.ts:151

`Abstract` subscribeTopic

subscribeTopic(topic, options, requestId?): number
Subscribe a topic.
Parameters
- topic: string
- options: TopicOptions
- Optional requestId: number
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraStreamChannel.ts:215

`Abstract` unsubscribeTopic

unsubscribeTopic(topic, options): number
Unsubscribe a topic.
Parameters
- topic: string
- options: TopicOptions
Returns number
- 0: Success.
- < 0: Failure.
- Defined in IAgoraStreamChannel.ts:228