Wasabi ExpressPlay SDK for Embedded Systems  1.23.0
Data Structures | Macros | Typedefs | Enumerations | Functions
WsbMediaDownload.h File Reference

Wasabi MediaDownload API. More...

#include "WsbTypes.h"

Go to the source code of this file.

Data Structures

struct  WSB_MediaDownload_Constraints
 Media Download resource constrains not to be exceeded. More...
 
struct  WSB_MediaDownload_Status
 The Media Download status. More...
 
struct  WSB_MediaDownload_Content
 The download content parameters. More...
 
struct  WSB_MediaDownload_ContentStatus
 The download content status. More...
 
struct  WSB_MediaDownload_Listener
 The Media Download listener interface. More...
 

Macros

#define WSB_MD_MAX_TRACKS   3
 

Typedefs

typedef struct WSB_MediaDownload WSB_MediaDownload
 An opaque Media Download instance handle. More...
 
typedef struct WSB_MediaDownload_Content WSB_MediaDownload_Content
 The download content parameters. More...
 

Enumerations

enum  WSB_MediaDownload_State {
  WSB_MDS_PAUSED = 1,
  WSB_MDS_RUNNING
}
 The overall Media Download status. More...
 
enum  WSB_MediaDownload_SourceType {
  WSB_MDST_DASH = 1,
  WSB_MDST_SINGLE_FILE
}
 The content source type. More...
 
enum  WSB_MediaDownload_ContentState {
  WSB_MDCS_PENDING = 1,
  WSB_MDCS_IN_PROGRESS = 2,
  WSB_MDCS_FAILING = 3,
  WSB_MDCS_CANCELED = 4,
  WSB_MDCS_COMPLETED = 5
}
 Content download states. More...
 

Functions

WSB_EXPORT WSB_Result WSB_MediaDownload_Get (WSB_MediaDownload **download)
 Obtain a Media Download singleton reference. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_Release (WSB_MediaDownload *download)
 Release a Media Download singleton reference. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_SetListener (WSB_MediaDownload *download, void *client_context, const WSB_MediaDownload_Listener *listener)
 Set the listener. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_RemoveListener (WSB_MediaDownload *download)
 Remove the listener, if any. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_Pause (WSB_MediaDownload *download)
 Pause the Media Download. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_Resume (WSB_MediaDownload *download)
 Resume the Media Download. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_SetConstraints (WSB_MediaDownload *download, const WSB_MediaDownload_Constraints *constraints)
 Assign the Media Download constraints. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_QueryStatus (WSB_MediaDownload *download, WSB_MediaDownload_Status **status)
 Query the Media Download status. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_ReleaseStatus (WSB_MediaDownload *download, WSB_MediaDownload_Status *status)
 Release a Media Download status object earlier obtained through WSB_MediaDownload_QueryStatus. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_AddContent (WSB_MediaDownload *download, const char *path, const WSB_MediaDownload_Content *content)
 Register a new content for download. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_CancelContent (WSB_MediaDownload *download, const char *path)
 Cancel the content from download. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_QueryContentStatus (WSB_MediaDownload *download, const char *path, WSB_MediaDownload_ContentStatus **content_status)
 Query the status of the content being downloaded. More...
 
WSB_EXPORT WSB_Result WSB_MediaDownload_ReleaseContentStatus (WSB_MediaDownload *download, WSB_MediaDownload_ContentStatus *content_status)
 Release content status object earlier obtained through WSB_MediaDownload_QueryContentStatus. More...
 

Detailed Description

Wasabi MediaDownload API.

Macro Definition Documentation

◆ WSB_MD_MAX_TRACKS

#define WSB_MD_MAX_TRACKS   3

Typedef Documentation

◆ WSB_MediaDownload

An opaque Media Download instance handle.

See also
WSB_MediaDownload_Get

◆ WSB_MediaDownload_Content

The download content parameters.

Since
1.21

Enumeration Type Documentation

◆ WSB_MediaDownload_ContentState

Content download states.

Since
1.21
Enumerator
WSB_MDCS_PENDING 
WSB_MDCS_IN_PROGRESS 
WSB_MDCS_FAILING 
WSB_MDCS_CANCELED 
WSB_MDCS_COMPLETED 

◆ WSB_MediaDownload_SourceType

The content source type.

Since
1.21
Enumerator
WSB_MDST_DASH 
WSB_MDST_SINGLE_FILE 

◆ WSB_MediaDownload_State

The overall Media Download status.

Since
1.21
Enumerator
WSB_MDS_PAUSED 

The Media Download has been paused, or it hasn't been resumed.

In this state, no content is being downloaded, the listener, if any, is not invoked.

See also
WSB_MediaDownload_Resume
WSB_MediaDownload_Pause
WSB_MDS_RUNNING 

The Media Download is running, i.e.

it has been resumed.

Any content download will be attempted. The listener, if any, callbacks will be invoked as appropriate.

See also
WSB_MediaDownload_Resume
WSB_MediaDownload_Pause