Agora Java API Reference for Android
Public Attributes | List of all members
agora::streaming::StreamingContext Struct Reference

#include <IAgoraStreamingKit.h>

Public Attributes

IStreamingEventHandlereventHandler
 
const char * appId
 
void * context
 
bool enableAudioStreaming
 
bool enableVideoStreaming
 
AudioStreamConfiguration audioStreamConfiguration
 
VideoStreamConfiguration videoStreamConfiguration
 

Detailed Description

The definition of StreamingContext.

Member Data Documentation

◆ eventHandler

IStreamingEventHandler* agora::streaming::StreamingContext::eventHandler

The event handler for IStreamingKit.

◆ appId

const char* agora::streaming::StreamingContext::appId

The App ID issued to the developers by Agora. Apply for a new one from Agora if it is missing from your kit.

◆ context

void* agora::streaming::StreamingContext::context

For Android, it is the context of Activity or Application.

◆ enableAudioStreaming

bool agora::streaming::StreamingContext::enableAudioStreaming

Enables or disables audio streaming.

Audio streaming is enabled by default.

Parameters
enabledDetermines whether to enable audio streaming:
  • true: (Default) Enable audio streaming, that is, to start publish the audio stream when streaming is started .
  • false: Disable audio streaming.
Returns
  • 0: Success.
  • < 0: Failure.

◆ enableVideoStreaming

bool agora::streaming::StreamingContext::enableVideoStreaming

Enables or disables video streaming.

Video streaming is enabled by default.

Parameters
enabledDetermines whether to enable video streaming:
  • true: (Default) Enable video streaming, that is, to publish the video stream when streaming is started .
  • false: Disable video streaming.
Returns
  • 0: Success.
  • < 0: Failure.

◆ audioStreamConfiguration

AudioStreamConfiguration agora::streaming::StreamingContext::audioStreamConfiguration

The configuration for the audio stream

◆ videoStreamConfiguration

VideoStreamConfiguration agora::streaming::StreamingContext::videoStreamConfiguration

The configuration for the video stream