OptionsProvider
Stay organized with collections
Save and categorize content based on your preferences.
Developers should implement this interface to provide options needed to create and
initialize CastContext
.
The implementation class must have a constructor without argument. The SDK will call that
constructor to instantiate a new instance.
Public Methods
public abstract CastOptions
getCastOptions
( Context
appContext)
Provides CastOptions
,
which affects discovery and session management of a Cast device.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eOptionsProvider\u003c/code\u003e interface is implemented by developers to supply options for creating and initializing a \u003ccode\u003eCastContext\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eImplementations must have a no-argument constructor for instantiation by the SDK.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods for defining \u003ccode\u003eCastOptions\u003c/code\u003e to control Cast device discovery and session management.\u003c/p\u003e\n"],["\u003cp\u003eIt allows providing custom \u003ccode\u003eSessionProvider\u003c/code\u003e instances for handling non-Cast devices, which is optional.\u003c/p\u003e\n"]]],["Developers must implement the `OptionsProvider` interface to configure `CastContext`. Implementations require a no-argument constructor for SDK instantiation. `getCastOptions` method provides `CastOptions` affecting Cast device discovery and session management and it must not be null. `getAdditionalSessionProviders` optionally supplies custom `SessionProvider` instances for non-Cast devices. Both methods take the application context as input, `getAdditionalSessionProviders` can return null.\n"],null,["# OptionsProvider\n\npublic interface **OptionsProvider** \nDevelopers should implement this interface to provide options needed to create and\ninitialize [CastContext](/android/reference/com/google/android/gms/cast/framework/CastContext).\nThe implementation class must have a constructor without argument. The SDK will call that\nconstructor to instantiate a new instance. \n\n### Public Method Summary\n\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| abstract [List](//developer.android.com/reference/java/util/List.html)\\\u003c[SessionProvider](/android/reference/com/google/android/gms/cast/framework/SessionProvider)\\\u003e | [getAdditionalSessionProviders](/android/reference/com/google/android/gms/cast/framework/OptionsProvider#getAdditionalSessionProviders(android.content.Context))([Context](//developer.android.com/reference/android/content/Context.html) appContext) Provides a list of custom [SessionProvider](/android/reference/com/google/android/gms/cast/framework/SessionProvider) instances for non-Cast devices. |\n| abstract [CastOptions](/android/reference/com/google/android/gms/cast/framework/CastOptions) | [getCastOptions](/android/reference/com/google/android/gms/cast/framework/OptionsProvider#getCastOptions(android.content.Context))([Context](//developer.android.com/reference/android/content/Context.html) appContext) Provides [CastOptions](/android/reference/com/google/android/gms/cast/framework/CastOptions), which affects discovery and session management of a Cast device. |\n\nPublic Methods\n--------------\n\n#### public abstract [List](//developer.android.com/reference/java/util/List.html)\\\u003c[SessionProvider](/android/reference/com/google/android/gms/cast/framework/SessionProvider)\\\u003e\n**getAdditionalSessionProviders** ([Context](//developer.android.com/reference/android/content/Context.html) appContext)\n\nProvides a list of custom [SessionProvider](/android/reference/com/google/android/gms/cast/framework/SessionProvider)\ninstances for non-Cast devices. This is optional. \n\n##### Parameters\n\n| appContext | The application [Context](//developer.android.com/reference/android/content/Context.html). |\n|------------|--------------------------------------------------------------------------------------------|\n\n##### Returns\n\n- the list of [SessionProvider](/android/reference/com/google/android/gms/cast/framework/SessionProvider) instances, may be `null`. \n\n#### public abstract [CastOptions](/android/reference/com/google/android/gms/cast/framework/CastOptions)\n**getCastOptions** ([Context](//developer.android.com/reference/android/content/Context.html) appContext)\n\nProvides [CastOptions](/android/reference/com/google/android/gms/cast/framework/CastOptions),\nwhich affects discovery and session management of a Cast device. \n\n##### Parameters\n\n| appContext | The application [Context](//developer.android.com/reference/android/content/Context.html). |\n|------------|--------------------------------------------------------------------------------------------|\n\n##### Returns\n\n- the [CastOptions](/android/reference/com/google/android/gms/cast/framework/CastOptions), must not be `null`."]]
