HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk.common

Class s7sdk.common.WebVtt

WebVtt is a class for parsing WebVtt content which could be used for various purpose

Class Summary
Constructor Attributes Constructor Name and Description
 
s7sdk.common.WebVtt(type, items)
Field Summary
Field Attributes Field Name and Description
<static>  
s7sdk.common.WebVtt.TYPE_CAPTION
Indicates the contents are captions.
<static>  
s7sdk.common.WebVtt.TYPE_METADATA
Indicates the contents are metadata.
<static>  
s7sdk.common.WebVtt.TYPE_NAVIGATION
Indicates the contents are navigation cues.
<static>  
s7sdk.common.WebVtt.TYPE_UNKNOWN
Indicates the contents are of an unknown type.
Method Summary
Method Attributes Method Name and Description
 
Return an array of WebVttItem.
 
Return the type of WebVtt content.
<static>  
s7sdk.common.WebVtt.parse(vttText, type)
Parse the contents from a String and return a WebVtt object.
Class Detail
s7sdk.common.WebVtt(type, items)
Parameters:
{String} type
The type of the WebVtt contents.
{Array} items
Any array of s7sdk.common.WebVttItem.
See:
s7sdk.common.WebVttItem
Field Detail
<static> s7sdk.common.WebVtt.TYPE_CAPTION
Indicates the contents are captions.

<static> s7sdk.common.WebVtt.TYPE_METADATA
Indicates the contents are metadata. This could be use for parsing Interactive Data for Videos.

<static> s7sdk.common.WebVtt.TYPE_NAVIGATION
Indicates the contents are navigation cues.

<static> s7sdk.common.WebVtt.TYPE_UNKNOWN
Indicates the contents are of an unknown type.
Method Detail
{Array} getItems()
Return an array of WebVttItem.
Returns:
{Array} WebVttItem.
See:
s7sdk.common.WebVttItem

getType()
Return the type of WebVtt content.

<static> s7sdk.common.WebVtt.parse(vttText, type)
Parse the contents from a String and return a WebVtt object.
Parameters:
{String} vttText
WebVTT contents.
{String} type
The type of the WebVtt contents.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Jan 30 2020 16:40:36 GMT+0200 (EET)