|
Wasabi ExpressPlay SDK for Desktop Systems
1.23.0
|
Wasabi Media Playback API. More...
Go to the source code of this file.
Data Structures | |
| struct | WSB_Player_Event |
| Structure used as the base for all event structures. More... | |
| struct | WSB_Player_AckEvent |
| Event data for reporting a successful command execution. More... | |
| struct | WSB_Player_NackEvent |
| Event data for reporting failure of a requested command. More... | |
| struct | WSB_Player_PongNotificationEvent |
| Event data for reporting that the decoder sent a pong reply in response to a ping. More... | |
| struct | WSB_Player_DecoderStateNotificationEvent |
| Event data for reporting a new decoder state. More... | |
| struct | WSB_Player_DecodingErrorDetails |
| Error code and message for a decoder event notification. More... | |
| struct | WSB_Player_DecoderEventNotificationEvent |
| Event data for reporting a decoder event type and error details. More... | |
| struct | WSB_Player_VolumeNotificationEvent |
| Event data for reporting a volume change. More... | |
| struct | WSB_Player_StreamTimeCodeNotificationEvent |
| Event data for reporting a seek to a particular time in a media presentation. More... | |
| struct | WSB_Player_StreamPositionNotificationEvent |
| Event data for reporting a seek to a particular position. More... | |
| struct | WSB_Player_StreamInfoNotificationEvent |
| Event data for reporting information about a stream, and the update mask. More... | |
| struct | WSB_Player_DRMStateNotificationEvent |
| Event data for reporting the DRM state. More... | |
| struct | WSB_Player_BufferingNotificationEvent |
| Event data for reporting the number of buffer bytes available versus the number needed. More... | |
| struct | WSB_Player_GotoUrlNotificationEvent |
| Event data for reporting a URL to which the player was directed. More... | |
| struct | WSB_Player_PropertyNotificationEvent |
| Event data for reporting information about a property. More... | |
| struct | WSB_Player_EventListener |
| This structure pairs a listener instance value with a function pointer for receiving events. More... | |
Typedefs | |
| typedef struct WSB_Player | WSB_Player |
| A WSB_Player object can be used to play audio and video content, and to control such playback, by issuing commands to it to commence play, pause, stop, set the volume, seek to a particular position, etc. More... | |
Functions | |
| WSB_EXPORT WSB_Result | WSB_Player_Create (WSB_Player_EventListener listener, WSB_Player_MsgThreadModel msg_model, WSB_Player **playback) |
| Creates an instance of a WSB_Player object, and registers the passed-in listener to be notified of player events. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_PumpMessage (WSB_Player *playback, WSB_Int32 timeout) |
| Asks the WSB_Player instance to send a message in its queue to the listener registered in the call to WSB_Player_Create. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_SetInput (WSB_Player *playback, const char *name, const char *mime_type) |
| Opens a named media file. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_SetInputEx (WSB_Player *playback, const char *name, const char *mime_type, WSB_Int32 flags, const void *license_data, WSB_Size license_data_size, WSB_Int32 audio_track, WSB_Int32 video_track) |
| Opens a named media file, and optionally specifies the particular audio and/or video track to be played. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_SetVideoOutput (WSB_Player *playback, const char *output_name) |
| Sets the destination for the video output, such as a pointer to a window encoded as hex in the string. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_SetAudioOutput (WSB_Player *playback, const char *output_name) |
| Sets the destination for the audio output. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_SetVolume (WSB_Player *playback, float volume) |
| Sets the volume on the audio output. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_SetProperty (WSB_Player *playback, WSB_Player_PropertyScope scope, const char *target, const char *name, SHI_DataType type, const SHI_DataValue *value) |
| Sets a property. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_Play (WSB_Player *playback) |
| Commences play. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_Pause (WSB_Player *playback) |
| Pauses output (playback). More... | |
| WSB_EXPORT WSB_Result | WSB_Player_Stop (WSB_Player *playback) |
| Stops output. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_SetFullscreen (WSB_Player *playback, WSB_Boolean fullscreen) |
| Enters or exits fullscreen mode. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_Seek (WSB_Player *playback, WSB_Int32 offset, WSB_Int32 range) |
| Attempts to move the stream to the specified position. More... | |
| WSB_EXPORT WSB_Result | WSB_Player_Destroy (WSB_Player *playback) |
| Destroys the specified WSB_Player object. More... | |
Wasabi Media Playback API.
| #define WSB_PLAYER_INPUT_FLAG_AUDIO_TRACK 0x0001 |
Flags that determine behavior of SetInputEx function.
| #define WSB_PLAYER_INPUT_FLAG_TRACK_BY_INDEX 0x0004 |
| #define WSB_PLAYER_INPUT_FLAG_VIDEO_TRACK 0x0002 |
| #define WSB_PLAYER_STREAM_INFO_FLAG_CONTINUOUS 0x02 |
Flag that indicates that the stream is a continuous stream.
| #define WSB_PLAYER_STREAM_INFO_FLAG_VBR 0x01 |
Flag that indicates that the stream has a variable bitrate.
| #define WSB_PLAYER_STREAM_INFO_MASK_ALL 0x1FFF |
Stream information mask identifiers.
| #define WSB_PLAYER_STREAM_INFO_MASK_AVERAGE_BITRATE 0x0008 |
| #define WSB_PLAYER_STREAM_INFO_MASK_CHANNEL_COUNT 0x0100 |
| #define WSB_PLAYER_STREAM_INFO_MASK_DATA_TYPE 0x1000 |
| #define WSB_PLAYER_STREAM_INFO_MASK_DURATION 0x0040 |
| #define WSB_PLAYER_STREAM_INFO_MASK_FLAGS 0x0800 |
| #define WSB_PLAYER_STREAM_INFO_MASK_HEIGHT 0x0400 |
| #define WSB_PLAYER_STREAM_INFO_MASK_ID 0x0002 |
| #define WSB_PLAYER_STREAM_INFO_MASK_INSTANT_BITRATE 0x0010 |
| #define WSB_PLAYER_STREAM_INFO_MASK_NOMINAL_BITRATE 0x0004 |
| #define WSB_PLAYER_STREAM_INFO_MASK_SAMPLE_RATE 0x0080 |
| #define WSB_PLAYER_STREAM_INFO_MASK_SIZE 0x0020 |
| #define WSB_PLAYER_STREAM_INFO_MASK_TYPE 0x0001 |
| #define WSB_PLAYER_STREAM_INFO_MASK_WIDTH 0x0200 |
| typedef struct WSB_Player WSB_Player |
A WSB_Player object can be used to play audio and video content, and to control such playback, by issuing commands to it to commence play, pause, stop, set the volume, seek to a particular position, etc.
| enum WSB_Player_CommandId |
Command identifiers.
| enum WSB_Player_DRMState |
| enum WSB_Player_EventType |
Event type identifiers.
Thread model identifiers.
If the model specified on WSB_Player creation (WSB_Player_Create) is WSB_PLAYER_MSG_MODEL_NATIVE, then the event listener callback that is registered in the call to WSB_Player_Create will be called in the UI native thread (e.g., Cocoa for the Mac and Windows message loop for Windows). If the model specified is WSB_PLAYER_MSG_MODEL_RAW, then the WSB_Player_PumpMessage method must be called in order to have the listener called, once per event that has not yet been reported.
| Enumerator | |
|---|---|
| WSB_PLAYER_MSG_MODEL_NATIVE | |
| WSB_PLAYER_MSG_MODEL_RAW | |