Wasabi ExpressPlay SDK for Embedded Systems  1.23.0
WsbMs3Client.h
Go to the documentation of this file.
1 /*****************************************************************
2 |
3 | Wasabi - MS3 Client API
4 |
5 | $Id: WsbMs3Client.h 13428 2017-10-20 00:09:34Z hwa $
6 | Original author: Eric Swenson
7 |
8 | This software is provided to you pursuant to your agreement
9 | with Intertrust Technologies Corporation ("Intertrust").
10 | This software may be used only in accordance with the terms
11 | of the agreement.
12 |
13 | Copyright (c) 2009-2014 by Intertrust. All rights reserved.
14 |
15 ****************************************************************/
21 #ifndef _WSB_MS3_CLIENT_H_
22 #define _WSB_MS3_CLIENT_H_
23 
24 /*----------------------------------------------------------------------
25 | includes
26 +---------------------------------------------------------------------*/
27 #include "ShiData.h"
28 #include "WsbTypes.h"
29 #include "WsbMs3Sas.h"
30 
31 /*----------------------------------------------------------------------
32 | interfaces
33 +---------------------------------------------------------------------*/
34 #if defined(__cplusplus)
35 extern "C" {
36 #endif
37 
48 
63 WSB_EXPORT WSB_Result
64 WSB_Ms3Client_CheckForMs3Url(const char* url);
65 
72 WSB_EXPORT WSB_Result
74 
83 WSB_EXPORT WSB_Result
85 
94 WSB_EXPORT WSB_Result
96 
105 WSB_EXPORT WSB_Result
107 
124 WSB_EXPORT WSB_Result
126  const char* url,
127  WSB_Ms3Sas** sas,
128  WSB_UInt32* http_result_code,
129  SHI_Data** content_url);
130 
146 WSB_EXPORT WSB_Result
148  const char* sad,
149  WSB_Size sad_size,
150  WSB_Ms3Sas** sas,
151  WSB_UInt32* http_result_code,
152  SHI_Data** content_url);
153 
159 WSB_EXPORT WSB_Result
161 
164 #if defined(__cplusplus)
165 }
166 #endif
167 
168 #endif /* _WSB_MS3_CLIENT_H_ */
WSB_EXPORT WSB_Result WSB_Ms3Client_Create(WSB_Ms3Client **client)
Creates a WSB_Ms3Client object.
WSB_EXPORT WSB_Result WSB_Ms3Client_GetSas(WSB_Ms3Client *client, const char *url, WSB_Ms3Sas **sas, WSB_UInt32 *http_result_code, SHI_Data **content_url)
Retrieves an MS3 SAS from the MS3 server specified by URL.
WSB_EXPORT WSB_Result WSB_Ms3Client_Destroy(WSB_Ms3Client *client)
Destroys a WSB_Ms3Client object.
WSB_Boolean
Boolean type used for variables that can be true (WSB_TRUE) or false (WSB_FALSE). ...
Definition: WsbTypes.h:71
WSB_EXPORT WSB_Result WSB_Ms3Client_SetAcceptCertHostnameMismatch(WSB_Ms3Client *client, WSB_Boolean state)
Configures the MS3 client to accept or reject certificates from the MS3 server whose hostname doesn't...
WSB_UInt32 WSB_Flags
Type used to represent a bit pattern signifying a combination of flags that can be on or off...
Definition: WsbTypes.h:93
struct WSB_Ms3Sas WSB_Ms3Sas
A WSB_Ms3Sas object provides an interface to manipulate an MS3 SAS.
Definition: WsbMs3Sas.h:47
WSB_EXPORT WSB_Result WSB_Ms3Client_SetAcceptSelfSignedCerts(WSB_Ms3Client *client, WSB_Boolean state)
Configures the MS3 client to accept or reject self-signed certificates from the MS3 server...
WSB_EXPORT WSB_Result WSB_Ms3Client_GetSasFromSad(WSB_Ms3Client *client, const char *sad, WSB_Size sad_size, WSB_Ms3Sas **sas, WSB_UInt32 *http_result_code, SHI_Data **content_url)
Retrieves an MS3 SAS from the MS3 server specified by a SAD document.
WSB_EXPORT WSB_Result WSB_Ms3Client_CheckForMs3Url(const char *url)
Performs a check of the supplied URL and indicates whether the URL is likely an MS3 URL...
int WSB_Result
Signed integer value representing a function or method result (return value).
Definition: WsbTypes.h:83
unsigned int WSB_UInt32
32-bit (or more) unsigned integer
Definition: WsbTypes.h:36
WSB_EXPORT WSB_Result WSB_Ms3Client_SetTransformMedia(WSB_Ms3Client *client, WSB_Flags state)
Configures the MS3 client to add extra HTTP header during MS3 SAS retrieval for the purpose of transf...
struct SHI_Data SHI_Data
A SHI_Data object represents a typed data object.
Definition: EmbProcessor.h:231
Wasabi MS3 SAS API.
struct WSB_Ms3Client WSB_Ms3Client
A WSB_Ms3Client object provides an interface to acquire MS3 rights from an MS3 server.
Definition: WsbMs3Client.h:47
Wasabi Result.
Generic Data Objects.
WSB_UInt32 WSB_Size
An unsigned integer used to represent a measurable quantity (e.g., the size of a file).
Definition: WsbTypes.h:104