Credentials data used to identify the credentials of the sender.
language
nullable string
Optional language to add to the Accept-Language header value when
launching the receiver application. Ignored if joining an already
existing session. The value is represented as '-' tag
as per RFC 5646. For example 'es-ES'.
requestSessionTimeout
number
The timeout used for requesting a session for the application in
milliseconds. Defaults to the value of
chrome.cast.timeout.requestSession.
[[["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-09-18 UTC."],[[["\u003cp\u003e\u003ccode\u003echrome.cast.SessionRequest\u003c/code\u003e is used to initiate or join a Google Cast session with a receiver application.\u003c/p\u003e\n"],["\u003cp\u003eIt requires the receiver application ID (\u003ccode\u003eappId\u003c/code\u003e) and optionally accepts capabilities, timeout, Android receiver compatibility, and credentials data.\u003c/p\u003e\n"],["\u003cp\u003eKey properties include \u003ccode\u003eappId\u003c/code\u003e, \u003ccode\u003ecapabilities\u003c/code\u003e, \u003ccode\u003ecredentialsData\u003c/code\u003e, and \u003ccode\u003eandroidReceiverCompatible\u003c/code\u003e for configuring the session request.\u003c/p\u003e\n"],["\u003cp\u003eIt allows specifying the required capabilities of the receiver device and credentials for sender identification.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can set a timeout for the session request and indicate Android receiver compatibility.\u003c/p\u003e\n"]]],["The `SessionRequest` class facilitates starting or connecting to a session. It requires an `appId` and accepts optional parameters: `capabilities` (receiver requirements), `timeout` (session request duration), `androidReceiverCompatible` (Android compatibility), and `credentialsData` (sender credentials). Properties include these parameters, plus `language` for receiver launch and `requestSessionTimeout` for request duration. It defines the specifications to request a casting session.\n"],null,["chrome.[cast](/cast/docs/reference/web_sender/chrome.cast).SessionRequest \nclass static\n\nA request to start or connect to a session.\n\nConstructor\n\nSessionRequest\n\nnew\nSessionRequest(appId, capabilities, timeout, androidReceiverCompatible, credentialsData)\n\n| Parameter ||\n|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| appId | string The receiver application id. |\n| capabilities | Optional Array of non-null [chrome.cast.Capability](/cast/docs/reference/web_sender/chrome.cast#.Capability) Required capabilities for the receiver. Value must not be null. |\n| timeout | Optional number Optional timeout for requesting a session for this application. |\n| androidReceiverCompatible | Optional boolean Indicates if the app is compatible with an Android Receiver. |\n| credentialsData | Optional [chrome.cast.CredentialsData](/cast/docs/reference/web_sender/chrome.cast.CredentialsData) Credentials data used to identify the credentials of the sender. Value may be null. |\n\nProperties\n\nandroidReceiverCompatible\n\nboolean\n\nIndicates if the app is compatible with an Android Receiver.\n\nappId\n\nstring\n\nThe receiver application id.\n\ncapabilities\n\nnon-null Array of non-null [chrome.cast.Capability](/cast/docs/reference/web_sender/chrome.cast#.Capability)\n\nCapabilities required of the receiver device.\n\ncredentialsData\n\nnullable [chrome.cast.CredentialsData](/cast/docs/reference/web_sender/chrome.cast.CredentialsData)\n\nCredentials data used to identify the credentials of the sender.\n\nlanguage\n\nnullable string\n\nOptional language to add to the Accept-Language header value when\nlaunching the receiver application. Ignored if joining an already\nexisting session. The value is represented as '-' tag as per RFC 5646. For example 'es-ES'.\n\nrequestSessionTimeout\n\nnumber\n\nThe timeout used for requesting a session for the application in\nmilliseconds. Defaults to the value of\nchrome.cast.timeout.requestSession."]]