Wasabi ExpressPlay SDK for iOS  1.10
Data Structures | Macros | Typedefs | Enumerations | Functions
WsbPlaylistProxy.h File Reference

Wasabi Playlist Proxy API. More...

#include "WsbResults.h"
#include "WsbTypes.h"

Go to the source code of this file.

Data Structures

struct  WSB_PlaylistProxy_MediaSourceParams
 Playlist Proxy URL parameters. More...
 

Macros

#define WSB_PP_FLAG_ENCRYPTED_HLS   (1<<0)
 Make Playlist Proxy produce encrypted HLS content. More...
 
#define WSB_PP_FLAG_AUTH_TOKEN_HEADER   (1<<1)
 Make Playlist Proxy require client authentication token in the request HTTP header 'Wasabi-AuthToken'. More...
 
#define WSB_PP_FLAG_DEBUG_SESSION_KEY   (1<<2)
 In debug builds only, support HLS AES-128 encryption key access through a proxy URL. More...
 

Typedefs

typedef struct WSB_PlaylistProxy WSB_PlaylistProxy
 

Enumerations

enum  WSB_PlaylistProxy_MediaSourceType {
  WSB_PPMST_SINGLE_FILE,
  WSB_PPMST_HLS,
  WSB_PPMST_DASH
}
 The media source type: More...
 
enum  WSB_PlaylistProxySessionKeyFormat {
  WSB_PPSKF_CLEAR,
  WSB_PPSKF_SKB
}
 The session key format enum. More...
 

Functions

WSB_EXPORT WSB_Result WSB_PlaylistProxy_Create (WSB_PlaylistProxy **self)
 Create a playlist proxy instance. More...
 
WSB_EXPORT WSB_Result WSB_PlaylistProxy_CreateWithFlags (WSB_UInt32 flags, WSB_PlaylistProxy **self)
 Create a playlist proxy instance with additional behavior selected through the flags. More...
 
WSB_EXPORT WSB_Result WSB_PlaylistProxy_Destroy (WSB_PlaylistProxy *self)
 Destroy a playlist proxy instance. More...
 
WSB_EXPORT WSB_Result WSB_PlaylistProxy_Start (WSB_PlaylistProxy *self)
 Start proxy execution. More...
 
WSB_EXPORT WSB_Result WSB_PlaylistProxy_Stop (WSB_PlaylistProxy *self)
 Stop proxy execution. More...
 
WSB_EXPORT WSB_Result WSB_PlaylistProxy_GetAndClearLastError (WSB_PlaylistProxy *self)
 Return the most recent Wasabi error (if any) detected by the proxy threads and clear it. More...
 
WSB_EXPORT WSB_Result WSB_PlaylistProxy_MakeUrl (WSB_PlaylistProxy *self, const char *media_source, WSB_PlaylistProxy_MediaSourceType media_source_type, const WSB_PlaylistProxy_MediaSourceParams *media_source_params, const char **http_url)
 Create an HTTP url that points to the proxy. More...
 
WSB_EXPORT WSB_Result WSB_PlaylistProxy_GetAuthToken (WSB_PlaylistProxy *self, char *auth_token, WSB_Size *token_size)
 Obtain the current Playlist Proxy authentication token. More...
 
WSB_EXPORT WSB_Result WSB_PlaylistProxy_GetSessionKey (WSB_PlaylistProxy *self, WSB_PlaylistProxySessionKeyFormat key_format, WSB_Byte *key, WSB_Size *key_size)
 Obtain the current Playlist Proxy session key. More...
 

Detailed Description

Wasabi Playlist Proxy API.

An HLS proxy for Marlin protected content.

An HTTP proxy server providing HLS Playlist and/or clear MPEG2 TS streams for the corresponding Marlin protected DASH, HLS, BBTS and PDCF streams. An iOS or Android native media player can be pointed to such a proxy with a Playlist URL. Additionally, any other content can be accessed through the Playlist Proxy when packaged as DCF.

The WSB_PlaylistProxy functionality is available on platforms running iOS and Android.