This guide provides information about the API changes between Browser TVSDK 2.4.4 and version 2.4.5.

Advertising workflow API element changes

These tables compare the advertising workflow API elements between Browser TVSDK version 2.4.4 and version 2.4.5.

Tables in this topic:

  • Ad
  • Opportunity
Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

Class Ad{
Ad (String id, Number type, Number duration, Boolean isMarker, AdAsset primaryAsset, 
Array <AdBannerAsset > companionAssets,

ContentTracker tracker, Number insertionType, Boolean 
isClickable);

};

Class Ad{

Ad (String id, Number adType, Number duration, Boolean isCustomAdMarker, AdAsset primaryAsset, 
Array <AdBannerAsset > companionAssets,
ContentTracker tracker,Number insertionType,Boolean isClickable,Boolean isCustomAd);



};

Opportunity

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

Class Opportunity {
    Opportunity (string id, Placement placement, Metadata settings, Metadata customParameter);  
    
};

Class Opportunity {
Opportunity (string id, Placement placement, Metadata settings ,Metadata customParams)

    
};

Customization API element changes

These tables compare the customization API elements between Browser TVSDK version 2.4.4 and version 2.4.5.

Tables in this topic:

  • NetworkConfiguration

NetworkConfig

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

Class NetworkConfiguration {

attribute Boolean useCookieHeaderForAllRequests;

   };

Class NetworkConfiguration {
   attribute Boolean
   useParentManifestQueryParameters;

};

Changes in the networkConfiguration.useCookieHeaderForAllRequests behavior

If the app sets networkConfiguration.useCookieHeaderForAllRequests to true, the SDK will set the withCredentials attribute to true for the XHR requests for the manifest, the segments, the key, and VTT. If the status code in the response is 0, the SDK will retry the same request without the withCredentials attribute.

For all non-segment files (manifest, key, and so on): keep track of whether withCredentials worked by URL. If if you have not already seen a failure for that URL, try withCredentials=true. If you get a failure, add that URL to the blacklist and retry without withCredentials. If the URL is already blacklisted, do not use withCredentials.

For all media segment files: keep track by origin instead of by URL, because each media file's URL is most likely unique.

Note:

Cookies and withCredentials will work for media files by domain.

The networkConfiguration.useCookieHeaderForAllRequests flag will not affect requests for a license. To set withCredentials attribute to true for a license request, you need to set withCredentials attribute in protection data or specify an authorization key in httpRequestHeaders of the protection data.

If networkConfiguration.useCookieHeaderForAllRequests is set to false, XHR requests will be made without the withCredentials attribute.

If the request was made without the withCredentials attribute, the status code 0 in the response will be treated as a failure . No special retry is required in this case.

DRM API element changes

These tables compare the DRM API elements between Browser TVSDK version 2.4.4 and version 2.4.5.

Tables in this topic:

  • DRMManager
  • DRMAuthenticationMethod

DRMManager

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

Class DRMManager  {

}

Class DRMManager  {

PSDKErrorCode setProtectionData(object protectionData);
readonly attribute PSDKEventDispatcher eventDispatcher;

}

DRMAuthenticationMethod

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API
This class is new in Version 2.4.5.

Class DRMAuthenticationMethod {
    const Number UNKNOWN= 0;
    const Number  ANONYMOUS= 1;
    const Number USERNAME_AND_PASSWORD= 2;
    };

Generic playback API element changes

These tables compare the generic playback API elements between Browser TVSDK version 2.4.4 and version 2.4.5.

Tables in this topic:

  • MediaPlayerView
  • MediaPlayerViewScalePolicy
  • Rectangle
  • MaintainAspectRatioScalePolicy
  • MediaPlayer
  • MediaPlayerItemLoader

MediaPlayerView

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

Class MediaPlayerView{

}

Class MediaPlayerView{
    attribute MediaPlayerViewScalePolicy;
    scalePolicy;
};

MediaPlayerViewScalePolicy

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

This class is new in version 2.4.5.

Interface MediaPlayerViewScalePolicy{
Rectangle adjustCallbackFunc ( Rectangle viewPort, Number
videoWidth , Number videoHeight )

};

Rectangle

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

This class is new in version 2.4.5.

Class Rectangle{
Rectangle (Number x,Number y,Number width ,Number height);
attribute Number x;
attribute Number y;
attribute Number width;
attribute Number height;

}; 

MaintainAspectRatioScalePolicy

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

This class is new in version 2.4.5.

Class MaintainAspectRatioScalePolicy {
MaintainAspectRatioScalePolicy() ;
static Rectangle adjustToCenter(Rectangle parent ,Rectangle child):

}; 

MediaPlayer

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

Class MediaPlayer {

PSDKErrorCode reset();

};

Class MediaPlayer {
object getCustomAdView();

};

Changes in the MediaPlayer.reset behavior

If set, the following parameters, will be initialized to their default values:

  • volume
  • abrControlParameters
  • ccStyle

MediaPlayerItemLoader

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

Class MediaPlayerItemLoader{

};

Class MediaPlayerItemLoader{
readonly attribute PSDKEventDispatcher eventDispatcher;

};

Utility and Helper API element changes

These tables compare the utility and helper API elements between Browser TVSDK version 2.4.4 and version 2.4.5.

Tables in this topic:

  • PlayerTechnology
  • PlayerTechnologyType
  • TextFormat

PlayerTechnology

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

class PlayerTechnology {
    string getSupportedTechnology (
    .MediaResource mediaResource,MediaPlayer mediaPlayer:

        Enum Type {
        MSE: "MediaSourceExtensions",
        VIDEO_TAG: "Plain Video Tag",
        FLASH: "Flash",
        UNKNOWN: "unknown"  
        };):

};

class PlayerTechnology {
string getSupportedTechnology (
MediaResource mediaResource):

   };

PlayerTechnologyType

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

This class is new in version 2.4.5.

     Class PlayerTechnologyType
    {
     const string MSE = "MediaSourceExtensions",
     const string VIDEO_TAG = "Plain Video Tag",
     const string FLASH = "Flash",
     const string UNKNOWN = "unknown"
     };

TextFormat

Browser TVSDK 2.4.4 API Browser TVSDK 2.4.5 API

Class TextFormat {
TextFormat (Number (font, Number fontColor,  Number edgeColor, Number fontEdge, Number backgroundColor, Number fillColor,  Number size,  Number fontOpacity, Number backgroundOpacity, Number fillOpacity); 

};

Class TextFormat {

TextFormat (Number eFont, Number eFontColor, Number eEdgeColor, Number eFontEdge, Number eBackgroundColor, Number eFillColor, Number eSize, Number nFontOpacity, Number nBackgroundOpacity,Number nFillOpacity, String sBottomInset, String sSafeArea); 

attribute String sBottomInset;
attribute String sSafeArea; 

};

This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License  Twitter™ and Facebook posts are not covered under the terms of Creative Commons.

Legal Notices   |   Online Privacy Policy