Android OpenTV Player SDK  4.25.0.1691567955
Watermark Class Reference

Detailed Description

Provides an interface to set up and control a unique watermark on the playback content, powered by the NexGuard-QuickMark SDK.

For further information on the NexGuard-QuickMark SDK please see the integration guide.

Watermark class handles the lifecycle interaction between the QuickMark SDK and the bound NMPVideoView player interface.

The minimum API for using the watermarking interface is 24. This is a minimum requirement from the QuickMark SDK.

Public Member Functions

 Watermark (Context context)
 Default constructor for Watermark. More...
 
void setToken (String token)
 Sets the customer system generated token to the Watermark. More...
 
void setUrl (String url)
 Sets the service endpoint URL to the Watermark. More...
 
void setTenant (String tenant)
 Sets the tenant name to the Watermark. More...
 
void bind (NMPVideoView player)
 Binds the Watermark to the passed NMPVideoView object after this call is made, the watermark will be active during playback of the passed NMPVideoView. More...
 
void unbind (NMPVideoView player)
 Unbinds the Watermark to the passed NMPVideoView object after this call is made, the watermark will no longer be active during playback of the passed NMPVideoView. More...
 
void addErrorListener (WatermarkErrorListener listener)
 Add an object interfacing WatermarkErrorListener to the Watermark to handle error callbacks Playback of content should be limited based on errors reported. More...
 
void removeErrorListener (WatermarkErrorListener listener)
 Remove an object interfacing WatermarkErrorListener from the Watermark. More...
 
void addMessageListener (WatermarkMessageListener listener)
 Add an object interfacing WatermarkMessageListener to the Watermark to handle message callbacks. More...
 
void removeMessageListener (WatermarkMessageListener listener)
 Remove an object interfacing WatermarkMessageListener from the Watermark. More...
 
NMPVideoView boundPlayer ()
 Returns the instance of the NMPVideoView object which this Watermark is currently bound to. More...
 

Constructor & Destructor Documentation

◆ Watermark()

Watermark ( Context  context)

Default constructor for Watermark.

Parameters
context

Member Function Documentation

◆ addErrorListener()

void addErrorListener ( WatermarkErrorListener  listener)

Add an object interfacing WatermarkErrorListener to the Watermark to handle error callbacks Playback of content should be limited based on errors reported.

Parameters
listenera WatermarkErrorListener instance

◆ addMessageListener()

void addMessageListener ( WatermarkMessageListener  listener)

Add an object interfacing WatermarkMessageListener to the Watermark to handle message callbacks.

Parameters
listenera WatermarkMessageListener instance

◆ bind()

void bind ( NMPVideoView  player)

Binds the Watermark to the passed NMPVideoView object after this call is made, the watermark will be active during playback of the passed NMPVideoView.

Parameters
playerthe NMPVideoView player instance

◆ boundPlayer()

NMPVideoView boundPlayer ( )

Returns the instance of the NMPVideoView object which this Watermark is currently bound to.

Returns
the NMPVideoView player object currently bound to this Watermark instance

◆ removeErrorListener()

void removeErrorListener ( WatermarkErrorListener  listener)

Remove an object interfacing WatermarkErrorListener from the Watermark.

Parameters
listenera WatermarkErrorListener instance

◆ removeMessageListener()

void removeMessageListener ( WatermarkMessageListener  listener)

Remove an object interfacing WatermarkMessageListener from the Watermark.

Parameters
listenera WatermarkMessageListener instance

◆ setTenant()

void setTenant ( String  tenant)

Sets the tenant name to the Watermark.

Parameters
tenantthe string representation of the tenant name

◆ setToken()

void setToken ( String  token)

Sets the customer system generated token to the Watermark.

Parameters
tokenthe string representation of the token

◆ setUrl()

void setUrl ( String  url)

Sets the service endpoint URL to the Watermark.

Parameters
urlthe string representation of the service endpoint URL

◆ unbind()

void unbind ( NMPVideoView  player)

Unbinds the Watermark to the passed NMPVideoView object after this call is made, the watermark will no longer be active during playback of the passed NMPVideoView.

Parameters
playerthe NMPVideoView player instance