Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- activeBreakAt(long, List<AdBreak>) - Static method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
-
Returns the active break containing the playhead, or
null. - AD_PROVIDER_NAME - Static variable in class com.castlabs.sdk.yospace.YospacePlugin
-
Name used by the server-side ad provider registry.
- addAnalyticObserver(AnalyticEventObserver) - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Adds a native Yospace analytics observer.
- addSessionListener(YospaceComponent.SessionListener) - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Adds a session lifecycle listener.
C
- canChangeVolume(boolean) - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Returns whether the requested mute state is permitted.
- canChangeVolume(boolean, long, List<AdBreak>) - Method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
- canClickThrough(String) - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Returns whether the current advert may be clicked through.
- canClickThrough(String, long, List<AdBreak>) - Method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
- canPause() - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Checks whether the active policy permits pausing.
- canPause(long, List<AdBreak>) - Method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
- canResize(boolean) - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Returns whether the requested fullscreen state is permitted.
- canResize(boolean, long, List<AdBreak>) - Method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
- canResizeCreative(boolean, long, List<AdBreak>) - Method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
- canSkip() - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Checks when the current advert may be skipped.
- canSkip(long, List<AdBreak>, long) - Method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
- canStop() - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Checks whether the active policy permits stopping.
- canStop(long, List<AdBreak>) - Method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
- com.castlabs.sdk.yospace - package com.castlabs.sdk.yospace
- CONTINUE_PLAYBACK - Enum constant in enum com.castlabs.sdk.yospace.YospacePlugin.NoAnalyticsBehavior
-
Keep playing the URL returned by Yospace.
- createAdLoader(PlayerConfig) - Method in class com.castlabs.sdk.yospace.YospacePlugin
- customHttpHeaders(Map<String, String>) - Method in class com.castlabs.sdk.yospace.YospacePlugin.MetadataBuilder
-
Sets headers used by Yospace's manifest and analytics requests.
D
- didSeek(long, long, List<AdBreak>) - Method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
- didSkip(long, long, List<AdBreak>) - Method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
E
- ERROR_DATA_RESULT_CODE - Static variable in class com.castlabs.sdk.yospace.YospacePlugin
-
Key in
CastlabsPlayerException.getErrorData()carrying the Yospace result code of a failed session initialization.
F
- FAIL - Enum constant in enum com.castlabs.sdk.yospace.YospacePlugin.NoAnalyticsBehavior
-
Fail playback.
G
- get() - Method in class com.castlabs.sdk.yospace.YospacePlugin.MetadataBuilder
-
Returns the configured metadata.
- getAdApi() - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Returns PRESTOplay's generic ad interaction API.
- getCurrentAd() - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Returns the active advert in PRESTOplay's generic form.
- getCurrentAdBreak() - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Returns the active native ad break.
- getCurrentAdvert() - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Returns the active native advert.
- getId() - Method in class com.castlabs.sdk.yospace.YospacePlugin
- getName() - Method in class com.castlabs.sdk.yospace.YospacePlugin
- getPositionForBookmark() - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Returns content time instead of stitched-stream time for VOD bookmarks.
- getPositionForPlayback(long) - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Converts a VOD content-time bookmark back to its stitched playhead.
- getSession() - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Returns the initialized active session, if any.
I
- id() - Method in class com.castlabs.sdk.yospace.YospaceComponent
- init(Context) - Method in class com.castlabs.sdk.yospace.YospacePlugin
K
- KEEP_PLAYING - Enum constant in enum com.castlabs.sdk.yospace.YospacePlugin.TimeoutBehavior
-
Keep playing the stream Yospace returned.
M
- MetadataBuilder(boolean, String) - Constructor for class com.castlabs.sdk.yospace.YospacePlugin.MetadataBuilder
-
Creates metadata for a VOD or DVR-live stream.
- MetadataBuilder(AnalyticsMetaData) - Constructor for class com.castlabs.sdk.yospace.YospacePlugin.MetadataBuilder
-
Adds Yospace values to existing analytics metadata.
N
- noAnalyticsBehavior(YospacePlugin.NoAnalyticsBehavior) - Method in class com.castlabs.sdk.yospace.YospacePlugin.MetadataBuilder
-
Overrides the plugin behavior when analytics are unavailable.
O
- onComponentViewsChanged(PlayerController) - Method in class com.castlabs.sdk.yospace.YospaceComponent
- onDestroy(PlayerController) - Method in class com.castlabs.sdk.yospace.YospaceComponent
- onOpenBundle(PlayerController, Bundle) - Method in class com.castlabs.sdk.yospace.YospaceComponent
- onOpenState(PlayerController, PlayerConfig) - Method in class com.castlabs.sdk.yospace.YospaceComponent
- onSessionError(AnalyticEventObserver.SessionError, Session) - Method in interface com.castlabs.sdk.yospace.YospaceComponent.SessionListener
-
Called when an initialized session reports a runtime error.
- onSessionResult(Session.SessionState, int, Session) - Method in interface com.castlabs.sdk.yospace.YospaceComponent.SessionListener
-
Called for INITIALISED, NO_ANALYTICS and FAILED initialization results.
R
- removeAnalyticObserver(AnalyticEventObserver) - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Removes a native Yospace analytics observer.
- removeSessionListener(YospaceComponent.SessionListener) - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Removes a session lifecycle listener.
- requestTimeoutMs(int) - Method in class com.castlabs.sdk.yospace.YospacePlugin.MetadataBuilder
-
Sets the Yospace initialization request timeout in milliseconds.
S
- scanComponentViews(ViewGroup) - Method in class com.castlabs.sdk.yospace.YospaceComponent
- SESSION_START_TIMEOUT_MS - Static variable in class com.castlabs.sdk.yospace.YospacePlugin
-
Maximum time spent waiting for Yospace to return the playback URL.
- setDebugFlags(int) - Static method in class com.castlabs.sdk.yospace.YospacePlugin
-
Enables Yospace diagnostic flags, including
YoLog.DEBUG_VALIDATION. - setDefaultPlaybackPolicyHandler(PlaybackPolicyHandler) - Method in class com.castlabs.sdk.yospace.YospacePlugin
-
Sets the default policy used by new controller components.
- setEnabled(boolean) - Method in class com.castlabs.sdk.yospace.YospacePlugin
-
Enables or disables components created after this call.
- setPlaybackPolicyHandler(PlaybackPolicyHandler) - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Replaces the playback policy used by future and current sessions.
- setSessionMode(Session.SessionMode) - Method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
- setViewSize(PlaybackEventHandler.ViewSize) - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Manually reports the view state; this takes precedence over automatic detection.
- STOP_PLAYBACK - Enum constant in enum com.castlabs.sdk.yospace.YospacePlugin.TimeoutBehavior
-
Stop playback.
T
- timeoutBehavior(YospacePlugin.TimeoutBehavior) - Method in class com.castlabs.sdk.yospace.YospacePlugin.MetadataBuilder
-
Overrides the plugin behavior when analytics time out.
- token(UUID) - Method in class com.castlabs.sdk.yospace.YospacePlugin.MetadataBuilder
-
Sets the optional client-side session identity.
U
- userAgent(String) - Method in class com.castlabs.sdk.yospace.YospacePlugin.MetadataBuilder
-
Sets the user agent used by Yospace requests.
V
- valueOf(String) - Static method in enum com.castlabs.sdk.yospace.YospacePlugin.NoAnalyticsBehavior
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.castlabs.sdk.yospace.YospacePlugin.TimeoutBehavior
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.castlabs.sdk.yospace.YospacePlugin.NoAnalyticsBehavior
-
Returns an array containing the constants of this enum type, in the order they are declared.
- values() - Static method in enum com.castlabs.sdk.yospace.YospacePlugin.TimeoutBehavior
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- willSeekTo(long) - Method in class com.castlabs.sdk.yospace.YospaceComponent
-
Returns the policy-adjusted destination, in milliseconds.
- willSeekTo(long, List<AdBreak>, long) - Method in class com.castlabs.sdk.yospace.YospacePlaybackPolicy
Y
- YospaceComponent - Class in com.castlabs.sdk.yospace
-
Per-controller Yospace API, available through
PlayerController.getComponent(Class). - YospaceComponent.SessionListener - Interface in com.castlabs.sdk.yospace
-
Receives initialization results and runtime session failures.
- YospacePlaybackPolicy - Class in com.castlabs.sdk.yospace
-
A small, player-independent implementation of Yospace's default playback policy.
- YospacePlaybackPolicy() - Constructor for class com.castlabs.sdk.yospace.YospacePlaybackPolicy
-
Creates the default playback policy.
- YospacePlugin - Class in com.castlabs.sdk.yospace
-
PRESTOplay integration for Yospace server-side ad insertion.
- YospacePlugin() - Constructor for class com.castlabs.sdk.yospace.YospacePlugin
-
Creates a plugin with playback-preserving error defaults.
- YospacePlugin(YospacePlugin.NoAnalyticsBehavior, YospacePlugin.TimeoutBehavior) - Constructor for class com.castlabs.sdk.yospace.YospacePlugin
-
Creates a plugin with explicit session error behavior.
- YospacePlugin.MetadataBuilder - Class in com.castlabs.sdk.yospace
-
Builder for the Yospace values stored in
AnalyticsMetaData. - YospacePlugin.NoAnalyticsBehavior - Enum in com.castlabs.sdk.yospace
-
What to do when a playable stream has no Yospace analytics.
- YospacePlugin.TimeoutBehavior - Enum in com.castlabs.sdk.yospace
-
What to do when an active analytics session times out.
All Classes and Interfaces|All Packages|Constant Field Values