Docs
THEOplayer.com
Preparing search index...
The search index is not available
THEOplayer Web SDK Connectors
THEOplayer Web SDK Connectors
Yospace Connector
Advert
Interface Advert
interface
Advert
{
broker
:
YospaceSession
;
addMacroSubstitution
(
key
,
value
)
:
void
;
getAdType
(
)
:
string
;
getAdVerifications
(
)
:
AdVerification
[]
;
getCompanionAdsByType
(
type
)
:
CompanionCreative
[]
;
getCompanionRequired
(
)
:
string
;
getDuration
(
)
:
number
;
getIdentifier
(
)
:
string
;
getLinearCreative
(
)
:
LinearCreative
;
getMediaIdentifier
(
)
:
string
;
getNonLinearCreativesByType
(
type
)
:
NonLinearCreative
[]
;
getProperties
(
)
:
VASTProperty
[]
;
getProperty
(
name
)
:
null
|
VASTProperty
;
getRemainingTime
(
playhead
)
:
number
;
getSequence
(
)
:
number
;
getSkipOffset
(
)
:
number
;
getStart
(
)
:
number
;
isActive
(
)
:
boolean
;
isFiller
(
)
:
boolean
;
isNonLinear
(
)
:
boolean
;
onErrorEvent
(
errorCode
?
)
:
void
;
onImpressionEvent
(
)
:
void
;
onViewableEvent
(
event
)
:
void
;
}
Hierarchy (
view full
)
AdvertEventHandler
Advert
Index
Properties
broker
Methods
add
Macro
Substitution
get
Ad
Type
get
Ad
Verifications
get
Companion
Ads
By
Type
get
Companion
Required
get
Duration
get
Identifier
get
Linear
Creative
get
Media
Identifier
get
Non
Linear
Creatives
By
Type
get
Properties
get
Property
get
Remaining
Time
get
Sequence
get
Skip
Offset
get
Start
is
Active
is
Filler
is
Non
Linear
on
Error
Event
on
Impression
Event
on
Viewable
Event
Properties
broker
broker
:
YospaceSession
Methods
add
Macro
Substitution
add
Macro
Substitution
(
key
,
value
)
:
void
Parameters
key
:
string
value
:
string
Returns
void
get
Ad
Type
get
Ad
Type
(
)
:
string
Returns
string
get
Ad
Verifications
get
Ad
Verifications
(
)
:
AdVerification
[]
Returns
AdVerification
[]
get
Companion
Ads
By
Type
get
Companion
Ads
By
Type
(
type
)
:
CompanionCreative
[]
Parameters
type
:
ResourceType
Returns
CompanionCreative
[]
get
Companion
Required
get
Companion
Required
(
)
:
string
Returns
string
get
Duration
get
Duration
(
)
:
number
Returns
number
get
Identifier
get
Identifier
(
)
:
string
Returns
string
get
Linear
Creative
get
Linear
Creative
(
)
:
LinearCreative
Returns
LinearCreative
get
Media
Identifier
get
Media
Identifier
(
)
:
string
Returns
string
get
Non
Linear
Creatives
By
Type
get
Non
Linear
Creatives
By
Type
(
type
)
:
NonLinearCreative
[]
Parameters
type
:
ResourceType
Returns
NonLinearCreative
[]
get
Properties
get
Properties
(
)
:
VASTProperty
[]
Returns
VASTProperty
[]
get
Property
get
Property
(
name
)
:
null
|
VASTProperty
Parameters
name
:
string
Returns
null
|
VASTProperty
get
Remaining
Time
get
Remaining
Time
(
playhead
)
:
number
Parameters
playhead
:
number
Returns
number
get
Sequence
get
Sequence
(
)
:
number
Returns
number
get
Skip
Offset
get
Skip
Offset
(
)
:
number
Returns
number
get
Start
get
Start
(
)
:
number
Returns
number
is
Active
is
Active
(
)
:
boolean
Returns
boolean
is
Filler
is
Filler
(
)
:
boolean
Returns
boolean
is
Non
Linear
is
Non
Linear
(
)
:
boolean
Returns
boolean
on
Error
Event
on
Error
Event
(
errorCode
?
)
:
void
Parameters
Optional
errorCode
:
number
Returns
void
on
Impression
Event
on
Impression
Event
(
)
:
void
Returns
void
on
Viewable
Event
on
Viewable
Event
(
event
)
:
void
Parameters
event
:
ViewableEvent
Returns
void
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
broker
add
Macro
Substitution
get
Ad
Type
get
Ad
Verifications
get
Companion
Ads
By
Type
get
Companion
Required
get
Duration
get
Identifier
get
Linear
Creative
get
Media
Identifier
get
Non
Linear
Creatives
By
Type
get
Properties
get
Property
get
Remaining
Time
get
Sequence
get
Skip
Offset
get
Start
is
Active
is
Filler
is
Non
Linear
on
Error
Event
on
Impression
Event
on
Viewable
Event
THEOplayer Web SDK Connectors
Loading...
Generated using
TypeDoc