com.intertrust.wasabi.media

Class PlaylistProxy

java.lang.Object

com.intertrust.wasabi.media.PlaylistProxy

public class PlaylistProxy
extends java.lang.Object

On iOS and Android, playback of Audio/Visual content is handled by the device's native media player. The ExpressPlay SDK interposes a Proxy (Playlist Proxy) between the raw protected media source and the native player. The Playlist Proxy reads from the protected media source, evaluates the license, and if the license allows it, decrypts the media and makes it available as an HLS stream to the native player.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PlaylistProxy.Flags Proxy creation flags.
static class	PlaylistProxy.LicenseType The type of license provided by a string.
static class	PlaylistProxy.MediaSourceParams Playlist Proxy URL parameters.
static class	PlaylistProxy.MediaSourceType The media source type: a single Marlin file, or a Marlin HLS playlist.
static class	PlaylistProxy.SessionKeyFormat The encrypted HLS session AES-128 key.
static class	PlaylistProxy.TrackSelector Media track selector mode.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MSG_TYPE_ERROR Message type

Constructor Summary

Constructors

Constructor and Description
PlaylistProxy() PlaylistProxy constructor.
PlaylistProxy(java.util.EnumSet<PlaylistProxy.Flags> flags) PlaylistProxy constructor with flags.
PlaylistProxy(java.util.EnumSet<PlaylistProxy.Flags> flags, PlaylistProxyListener listener, java.lang.Object handler) PlaylistProxy constructor with flags, listener, and handler.

Method Summary

Methods

Modifier and Type	Method and Description
void	getAndClearLastError() Check the Playlist Proxy execution status.
java.lang.String	getAuthToken() Obtain the current Playlist Proxy authentication token.
long	getNativeHandle() Get native handle.
byte[]	getSessionKey(PlaylistProxy.SessionKeyFormat format) Obtain the encrypted HLS session key.
java.lang.String	makeUrl(java.lang.String mediaSource, PlaylistProxy.MediaSourceType mediaSourceType, PlaylistProxy.MediaSourceParams mediaSourceParams) Make a Playlist Proxy URL.
void	start() Start running playlist proxy.
void	stop() Stop running playlist proxy.
void	unblockForLicense() Notify the proxy to proceed with license lookup and evaluation.
void	unblockForLicense(PlaylistProxy.LicenseType type, java.lang.String data) Notify the proxy to proceed with license evaluation, using the provided license data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_TYPE_ERROR

public static final int MSG_TYPE_ERROR

Message type

Since:

1.13

See Also:

Constant Field Values

Constructor Detail

PlaylistProxy

public PlaylistProxy(java.util.EnumSet<PlaylistProxy.Flags> flags,
             PlaylistProxyListener listener,
             java.lang.Object handler)
              throws ErrorCodeException,
                     java.lang.NullPointerException

PlaylistProxy constructor with flags, listener, and handler.

For Android, caller passes in either null or an android.os.Handler instance for the handler argument. When both listener and handler are passed in, the Playlist Proxy message is posted to the thread/queue associated with the handler. If only listener is passed in but handler is null, the Playlist Proxy message triggers the call to the listener method directly in a separate messaging thread.

For Linux, the handler argument is not used. When a listener is passed in, the Playlist Proxy message triggers the call to the listener method directly in a separate messaging thread.

Throws:

ErrorCodeException

java.lang.NullPointerException

Since:

1.13

See Also:

PlaylistProxyListener

PlaylistProxy

public PlaylistProxy(java.util.EnumSet<PlaylistProxy.Flags> flags)
              throws ErrorCodeException

PlaylistProxy constructor with flags.

Throws:

ErrorCodeException

Since:

1.8

See Also:

PlaylistProxy.Flags

PlaylistProxy

public PlaylistProxy()
              throws ErrorCodeException

PlaylistProxy constructor.

Throws:

ErrorCodeException

Method Detail

start

public void start()
           throws ErrorCodeException

Start running playlist proxy. See stop()

Throws:

ErrorCodeException

stop

public void stop()
          throws ErrorCodeException

Stop running playlist proxy.

Throws:

ErrorCodeException

getAuthToken

public java.lang.String getAuthToken()
                              throws ErrorCodeException

Obtain the current Playlist Proxy authentication token. Depending on the flags at the creation time, the Playlist Proxy may require the authentication token in the URL, in the HTTP request headers. See AUTH_TOKEN_HEADER macro for additional information.

Throws:

ErrorCodeException

Since:

1.8

getAndClearLastError

public void getAndClearLastError()
                          throws ErrorCodeException

Check the Playlist Proxy execution status. Throw exception corresponding to the most recent error reported by Playlist Proxy, if any. Clears the most recent error code as a side effect.

Throws:

ErrorCodeException

makeUrl

public java.lang.String makeUrl(java.lang.String mediaSource,
                       PlaylistProxy.MediaSourceType mediaSourceType,
                       PlaylistProxy.MediaSourceParams mediaSourceParams)
                         throws ErrorCodeException

Make a Playlist Proxy URL.

Parameters:

mediaSource - path or URL to the Marlin media source

mediaSourceType - mime type of the original media

mediaSourceParams - url parameters, can be null. However, in the case of SINGLE_FILE MediaSourceType, the sourceContentType must be set to select between BBTS ("video/mp2t"), PDCF or M4F ("video/mp4") and DCF (application/vnd.oma.drm.dcf). NOTE: the BB license or MS3 SAS used with DCF must relax the default Marlin output controls or the content will not be decrypted. This requires the SAS to carry an MS3 extension (of type 'wudo') or a the Marlin Broadband license to indicate a Marlin Broadband output control override (type 'urn:marlin:organization:intertrust:wudo').

Returns:

0 on success and error code on failure

Throws:

ErrorCodeException

unblockForLicense

public void unblockForLicense()
                       throws ErrorCodeException

Notify the proxy to proceed with license lookup and evaluation. The call is asynchronous with actual license lookup and evaluation. The proxy must have been created with the BLOCK_FOR_LICENSE_EXPLICIT flag.

Throws:

ErrorCodeException

Since:

1.11 HLS, 1.13 DASH

See Also:

PlaylistProxy.Flags.BLOCK_FOR_LICENSE_EXPLICIT

unblockForLicense

public void unblockForLicense(PlaylistProxy.LicenseType type,
                     java.lang.String data)
                       throws ErrorCodeException

Notify the proxy to proceed with license evaluation, using the provided license data. The call is asynchronous with actual license lookup and evaluation. The proxy must have been created with the BLOCK_FOR_LICENSE_EXPLICIT flag.

Parameters:

type - license type, corresponding to the data

data - the license data

Throws:

ErrorCodeException

Since:

1.11 HLS, 1.13 DASH

See Also:

PlaylistProxy.Flags.BLOCK_FOR_LICENSE_EXPLICIT

getSessionKey

public byte[] getSessionKey(PlaylistProxy.SessionKeyFormat format)
                     throws ErrorCodeException

Obtain the encrypted HLS session key. The Playlist Proxy must have been created with the PlaylistProxy.Flags.ENCRYPTED_HLS flag.

Throws:

ErrorCodeException

Since:

1.16

See Also:

PlaylistProxy.Flags.ENCRYPTED_HLS, PlaylistProxy.Flags.SESSION_KEY

getNativeHandle

public long getNativeHandle()

Get native handle. This function should not be used by application.