Global

Typedefs
typedef enum r5_stream_mode	r5_stream_mode_t
typedef enum r5_scale_mode	r5_scale_mode
typedef enum r5_media_type	r5_media_type
typedef enum r5_stream_format	r5_stream_format

Enumerations
enum	r5_log_level { r5_log_level_debug , r5_log_level_info , r5_log_level_warn , r5_log_level_error }
enum	r5_status {   r5_status_connected , r5_status_disconnected , r5_status_connection_error , r5_status_connection_timeout ,   r5_status_connection_close , r5_status_start_streaming , r5_status_stop_streaming , r5_status_netstatus ,   r5_status_audio_mute , r5_status_audio_unmute , r5_status_video_mute , r5_status_video_unmute ,   r5_status_license_error , r5_status_license_valid , r5_status_buffer_flush_start , r5_status_buffer_flush_empty ,   r5_status_video_render_start , r5_status_abr_level_change , r5_status_srtp_key_gen_error , r5_status_srtp_key_handle_error ,   r5_status_hardware_decode_error }
enum	r5_stream_mode { r5_stream_mode_stop , r5_stream_mode_subscribe , r5_stream_mode_publish }
enum	r5_buffer_state { r5_buffer_state_buffered , r5_buffer_state_needs_rebuffer , r5_buffer_state_flush_buffer , r5_buffer_state_rebuffering }
enum	r5_scale_mode { r5_scale_to_fill , r5_scale_to_fit , r5_scale_fill }
enum	r5_media_type { r5_media_type_video , r5_media_type_audio , r5_media_type_video_custom , r5_media_type_audio_custom }
enum	r5_stream_format { r5_stream_format_unknown , r5_stream_format_rgb , r5_stream_format_yuv_planar , r5_stream_format_yuv_biplanar }
enum	r5_protocol { r5_rtsp = 1 , r5_srtp = 2 , r5_null_srtp = 3 }

Functions
const char *	r5_string_for_status (int status)
void	r5_set_log_level (int level)
int	r5_get_log_level (void)

Detailed Description

Public enumeration types and utility functions

Typedef Documentation

r5_media_type

typedef enum r5_media_type r5_media_type

Type of r5_media for encoding

r5_scale_mode

typedef enum r5_scale_mode r5_scale_mode

Scale modes for GL rendering of incoming streams

r5_stream_format

typedef enum r5_stream_format r5_stream_format

Enum for stream format of incoming decoded stream data

r5_stream_mode_t

typedef enum r5_stream_mode r5_stream_mode_t

Streaming mode for an R5Stream

Enumeration Type Documentation

r5_buffer_state

enum r5_buffer_state

Buffering state of an R5Stream

r5_log_level

enum r5_log_level

Logging level for R5 Pro API

r5_media_type

enum r5_media_type

Type of r5_media for encoding

Enumerator
r5_media_type_video	Standard video using R5Camera.
r5_media_type_audio	Standard audio using R5Microphone.
r5_media_type_video_custom	Custom video source.
r5_media_type_audio_custom	Custom audio source.

r5_protocol

enum r5_protocol

Enum to match with protocol values in config and context

r5_scale_mode

enum r5_scale_mode

Scale modes for GL rendering of incoming streams

r5_status

enum r5_status

Status code for an R5Stream/R5Connection

Enumerator
r5_status_connected	A connection with the server has been established. Streaming has not started yet.
r5_status_disconnected	The connection with the server has been lost.
r5_status_connection_error	There was an error with the connection.
r5_status_connection_timeout	The connection has failed due to timeout.
r5_status_connection_close	The connection is fully closed. Wait for this before releasing assets.
r5_status_start_streaming	Streaming content has begun as a publisher or subscriber.
r5_status_stop_streaming	Streaming content has stopped.
r5_status_netstatus	A netstatus event has been received from the server.
r5_status_audio_mute	Publisher has muted their audio stream.
r5_status_audio_unmute	Publisher has unmuted their audio stream.
r5_status_video_mute	Publisher has muted their video stream.
r5_status_video_unmute	Publisher has unmuted their video stream.
r5_status_license_error	An error in validating the SDK license.
r5_status_license_valid	The license key provided for the SDK is deemed valid.
r5_status_buffer_flush_start	Publisher has started flushing queued packets post-broadcast.
r5_status_buffer_flush_empty	Publisher has completed flushing queued packets post-broadcast.
r5_status_video_render_start	Subscriber has rendered first video frame.
r5_status_abr_level_change	ABR Publisher has changed broadcast level.
r5_status_srtp_key_gen_error	There was a problem generating a key on this device.
r5_status_srtp_key_handle_error	There was a problem in the key exchange with the server.
r5_status_hardware_decode_error	There was a problem using hardware acceleration to start decode of incoming stream.

r5_stream_format

enum r5_stream_format

Enum for stream format of incoming decoded stream data

Enumerator
r5_stream_format_rgb	Non-hardware accelerated RGB. Uses SW Scalar for decode.
r5_stream_format_yuv_planar	Non-hardware accelerated YUV. Parses frames into YUV 3 planes.
r5_stream_format_yuv_biplanar	Non-hardware accelerated YUV. Parses frame to YUV bi-planar format.

r5_stream_mode

enum r5_stream_mode

Streaming mode for an R5Stream

Function Documentation

r5_get_log_level()

int r5_get_log_level

(

void

)

Returns

The current logging level for the R5 Pro library

r5_set_log_level()

void r5_set_log_level

(

int

level

)

Set logging level for the R5 Pro SDK

Parameters

level

r5_log_level of the level of logging desired

r5_string_for_status()

const char * r5_string_for_status

(

int

status

)

Format r5_status events into a readable string

Parameters

status

r5_status to stringify

Returns

A string representation of the status code