Usage

The plugin is implemented as static methods that can be called from Unity.

void Phenix.Init(ChannelExpressOptions options)

Initialize the plugin and create the ChannelExpress.

• options parameter of type ChannelExpressOptions(required)

The plugin is initialized with ChannelExpressOptions wich can be created with a builder as shown in the following code snippet:

1ChannelExpressOptions channelExpressOptions = new ChannelExpressOptions.ChannelExpressOptionsBuilder()
2    .WithBackendUri("https://example.yourdomain.com/phenix/")
3    .Build();
4Phenix.Init(channelExpressOptions);

bool Phenix.IsInitialized()

Check if the plugin has been intialized.

ChannelExpressOptions.ChannelExpressOptionsBuilder

• WithBackendUri(string backendUri)(required) - URL to your backend. We send requests here to authenticate and get streaming tokens.
• WithPCastUri(string pCastUri)(optional) - Allows overriding default PCast™ URI.
• WithAuthenticationToken(string authenticationToken)(optional) - The authentication token generated using the Phenix EdgeAuth library.

string JoinChannel(JoinChannelOptions options)

Join a channel and automatically view the most recent content published to that channel.

• options parameter of type JoinChannelOptions(required)
• return the channel unique identifier

1JoinChannelOptions joinChannelOptions = new JoinChannelOptions.JoinChannelOptionsBuilder()
2    .WithRoomAlias("MyAwesomeChannel")
3    .Build();
4string channelUuid = Phenix.JoinChannel(joinChannelOptions1);

JoinChannelOptions.JoinChannelOptionsBuilder

• WithRoomAlias(string roomAlias)(required)
• WithCapabilities(string[] capabilities)(optional) - The list of all capabilities to subscribe with.
• WithStreamToken(string streamToken)(optional) - alternative to room alias
• WithStreamSelectionStrategy(StreamSelectionStrategy streamSelectionStrategy)(optional) - choose the stream selection strategy. Possible values are StreamSelectionStrategy.HIGH_AVAILABILITY or StreamSelectionStrategy.MOST_RECENT

void LeaveChannel(string uuid)

Leave a Channel and stop viewing of its published content.

• uuid parameter of type string(required) - The channel unique identifier that the user wants to leave

1string channelUuid = ... //obtained when joining a channel
2Phenix.LeaveChannel(channelUuid);

bool IsChannelJoined(string uuid)

Check if the channel is joined.

• uuid parameter of type string(required) - The channel unique identifier

1string channelUuid = ... //obtained when joining a channel
2Phenix.IsChannelJoined(channelUuid)

bool IsJoined()

Check if any channel is joined.

1Phenix.IsJoined()

bool ChannelExists(string uuid)

Check if the channel exists.

• uuid parameter of type string(required) - The channel unique identifier

1string channelUuid = ... //obtained when joining a channel
2Phenix.ChannelExists(channelUuid)

string[] GetChannels()

Check which channels are currently joined.

• return a list containing the channel unique identifiers for all the channels that are joined

1string[] channels = Phenix.GetChannels();

Texture2D GetTexture(string uuid)

Get the texture that holds the published content.

• uuid parameter of type string(required) - The channel unique identifier
• return a texture of type Texture2D

1// Script that is attached to a GameObject
2private void Awake ()
3{
4    string channelUuid = ... //obtained when joining a channel
5    rend = GetComponent<Renderer>();
6    rend.material.mainTexture = Phenix.GetTexture(uuid);
7}

void RejoinChannel(string uuid)

Rejoin the channel.

• uuid parameter of type string(required) - The channel unique identifier

1// Script that is attached to a GameObject
2private void Awake ()
3{
4    string channelUuid = ... //obtained when joining a channel
5    Phenix.RejoinChannel(channelUuid);
6}

void SetBandwidthLimit(string uuid, PhenixDefinitionBandwidths bandwidth)

Limit the bandwidth of a channel.

• uuid parameter of type string(required) - The channel unique identifier
• bandwidth parameter of type PhenixDefinitionBandwidths(required) - The value to wich we want to limit the bandwidth

1// Script that is attached to a GameObject
2private void Awake ()
3{
4    string channelUuid = ... //obtained when joining a channel
5    Phenix.SetBandwidthLimit(channelUuid, PhenixDefinitionBandwidths.PhenixStandardDefinitionBandwidth);
6}

PhenixDefinitionBandwidths GetBandwidthLimit(string uuid)

Get the channel bandwidth limit.

• uuid parameter of type string(required) - The channel unique identifier

1// Script that is attached to a GameObject
2private void Awake ()
3{
4    string channelUuid = ... //obtained when joining a channel
5    Phenix.GetBandwidthLimit(channelUuid);
6}

void SetTextureFlip(string uuid, PhenixTextureFlipAxis axisFlip)

Flip the video around its axis.

• uuid parameter of type string(required) - The channel unique identifier
• axisFlip parameter of type PhenixTextureFlipAxis(required) - The value that defines around which axis to flip the video.

1// Script that is attached to a GameObject
2private void Awake ()
3{
4    string channelUuid = ... //obtained when joining a channel
5    SetTextureFlip(channelUuid, PhenixTextureFlipAxis.FlipUAxis);
6}

PhenixTextureFlipAxis GetTextureFlip(string uuid)

Get the axis around which the video is flipped.

• uuid parameter of type string(required) - The channel unique identifier

1// Script that is attached to a GameObject
2private void Awake ()
3{
4    string channelUuid = ... //obtained when joining a channel
5    Phenix.GetTextureFlip(channelUuid);
6}

OnSubscribeEvent(string uuid, PhenixRequestStatus requestStatus)

Triggered when a channel is joined or left.

1Phenix.OnSubscribeEvent callback;
2
3private void Awake()
4{
5    callback = new Phenix.OnSubscribeEvent((uuid, status) =>
6        {
7            print("uuid:" + uuid);
8            print("status:" + status);
9        }
10    );
11    Phenix.OnSubscribeEvent += callback;
12}
13
14private void OnDestroy()
15{
16    // Cleanup callback to avoid leaks
17    Phenix.OnSubscribeEvent -= callback;
18}

OnJoinChannelEvent(string uuid, PhenixRequestStatus requestStatus)

Triggered when a channel is joined or left.

1Phenix.OnJoinChannelEvent callback;
2
3private void Awake()
4{
5    callback = new Phenix.OnJoinChannelEvent((uuid, status) =>
6        {
7            print("uuid:" + uuid);
8            print("status:" + status);
9        }
10    );
11    Phenix.OnJoinChannelEvent += callback;
12}
13
14private void OnDestroy()
15{
16    // Cleanup callback to avoid leaks
17    Phenix.OnJoinChannelEvent -= callback;
18}

OnUnrecoverableErrorEvent(PhenixRequestStatus status, string description)

Triggered when an error occurs that the plugin can't recover from.

1Phenix.OnUnrecoverableErrorEvent callback;
2
3private void Awake()
4{
5    callback = new Phenix.OnUnrecoverableErrorEvent(status =>
6        {
7            print("status:" + status);
8        }
9    );
10    Phenix.OnUnrecoverableErrorEvent += callback;
11}
12
13private void OnDestroy()
14{
15    // Cleanup callback to avoid leaks
16    Phenix.OnUnrecoverableErrorEvent -= callback;
17}

JoinEvent(bool joined)

Triggered when at least one channel is joined or the user leaves all the channels.

1Phenix.JoinEvent callback;
2
3private void Awake()
4{
5    callback = new Phenix.JoinEvent(joined =>
6        {
7            print("At least one channel is joined:" + joined);
8        }
9    );
10    Phenix.OnJoinEvent += callback;
11}
12
13private void OnDestroy()
14{
15    // Cleanup callback to avoid leaks
16    Phenix.OnJoinEvent -= callback;
17}