Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eThe \u003ccode\u003ecast.framework.TextTracksManager\u003c/code\u003e manages text tracks within the Cast framework and should be accessed via the \u003ccode\u003ecast.framework.PlayerManager\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to add, create, retrieve (by ID, language, or active status), and set active text tracks.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use this class to control and customize text track behavior, including setting the style of displayed text.\u003c/p\u003e\n"],["\u003cp\u003eThe TextTracksManager throws errors if operations are performed with invalid IDs, languages, or if tracks are unavailable.\u003c/p\u003e\n"],["\u003cp\u003eThis class is essential for managing subtitles, captions, and other textual information associated with media playback on Cast devices.\u003c/p\u003e\n"]]],["The `TextTracksManager` class manages text tracks, accessible via `PlayerManager`. Key actions include: adding text tracks via `addTracks`, creating them with `createTrack`, and retrieving them using `getTracks`, `getTrackById`, or `getTracksByLanguage`. Tracks can be activated by ID (`setActiveByIds`) or language (`setActiveByLanguage`). The class also provides methods for managing track status by returning active id's (`getActiveIds`) or active tracks (`getActiveTracks`). `setTextTrackStyle` and `getTextTracksStyle` manage the text track styling.\n"],null,["# Class: TextTracksManager\n\ncast.[framework](/cast/docs/reference/web_receiver/cast.framework).TextTracksManager\n====================================================================================\n\nclass static\n\nManages text tracks.\n\nThrows\n\n: `non-null Error` If constructor is used directly.\n The TextTracksManager should only be accessed\n by calling [cast.framework.PlayerManager#getTextTracksManager](/cast/docs/reference/web_receiver/cast.framework.PlayerManager#getTextTracksManager).\n\nMethods\n-------\n\n### addTracks\n\naddTracks(tracks)\n\nAdds text tracks to the list.\n\n| #### Parameter ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| tracks | Array of non-null [cast.framework.messages.Track](/cast/docs/reference/web_receiver/cast.framework.messages.Track) Value must not be null. |\n\nThrows\n\n: `non-null Error` If tracks are not available,\n or trackId is not unique, or add non-text tracks.\n\n### createTrack\n\ncreateTrack() returns [cast.framework.messages.Track](/cast/docs/reference/web_receiver/cast.framework.messages.Track)\n\nCreates a text track.\n\nReturns\n\n: `non-null `[cast.framework.messages.Track](/cast/docs/reference/web_receiver/cast.framework.messages.Track)\n\n### getActiveIds\n\ngetActiveIds() returns Array of number\n\nGets all active text ids.\n\nThrows\n\n: `non-null Error` If tracksManager is not available.\n\nReturns\n\n: `non-null Array of number`\n\n### getActiveTracks\n\ngetActiveTracks() returns Array of non-null [cast.framework.messages.Track](/cast/docs/reference/web_receiver/cast.framework.messages.Track)\n\nGets all active text tracks.\n\nThrows\n\n: `non-null Error` If tracksManager is not available.\n\nReturns\n\n: `non-null Array of non-null `[cast.framework.messages.Track](/cast/docs/reference/web_receiver/cast.framework.messages.Track)\n\n### getTextTracksStyle\n\ngetTextTracksStyle() returns ([cast.framework.messages.TextTrackStyle](/cast/docs/reference/web_receiver/cast.framework.messages.TextTrackStyle) or undefined)\n\nReturns the current text track style.\n\nReturns\n\n: `(non-null `[cast.framework.messages.TextTrackStyle](/cast/docs/reference/web_receiver/cast.framework.messages.TextTrackStyle)` or undefined)`\n\n### getTrackById\n\ngetTrackById(id) returns [cast.framework.messages.Track](/cast/docs/reference/web_receiver/cast.framework.messages.Track)\n\nGets text track by id.\n\n| #### Parameter ||\n|----|--------|\n| id | number |\n\nThrows\n\n: `non-null Error` If id is not available or invalid.\n\nReturns\n\n: `nullable `[cast.framework.messages.Track](/cast/docs/reference/web_receiver/cast.framework.messages.Track)\n\n### getTracks\n\ngetTracks() returns Array of non-null [cast.framework.messages.Track](/cast/docs/reference/web_receiver/cast.framework.messages.Track)\n\nReturns all (non-forced) text tracks.\n\nReturns\n\n: `non-null Array of non-null `[cast.framework.messages.Track](/cast/docs/reference/web_receiver/cast.framework.messages.Track)\n\n### getTracksByLanguage\n\ngetTracksByLanguage(language) returns Array of non-null [cast.framework.messages.Track](/cast/docs/reference/web_receiver/cast.framework.messages.Track)\n\nGets text tracks by language.\n\n| #### Parameter ||\n|----------|--------------------------------------|\n| language | string Language tag as per RFC 5646. |\n\nThrows\n\n: `non-null Error` If language is not available.\n\nReturns\n\n: `non-null Array of non-null `[cast.framework.messages.Track](/cast/docs/reference/web_receiver/cast.framework.messages.Track)\n\n### setActiveByIds\n\nsetActiveByIds(newIds)\n\nSets text tracks to be active by id.\n\n| #### Parameter ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------|\n| newIds | Array of number The text track ids to be enabled. To clear text tracks set the value to an empty array or `null`. Value may be null. |\n\nThrows\n\n: `non-null Error` If id is invalid.\n\n### setActiveByLanguage\n\nsetActiveByLanguage(language)\n\nSets text tracks to be active by language. Only the first matching\nlanguage track will be enabled.\n\n| #### Parameter ||\n|----------|--------------------------------------|\n| language | string Language tag as per RFC 5646. |\n\nThrows\n\n: `non-null Error` If language is not available or invalid.\n\n### setTextTrackStyle\n\nsetTextTrackStyle(style)\n\nSets text track style.\n\n| #### Parameter ||\n|-------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| style | [cast.framework.messages.TextTrackStyle](/cast/docs/reference/web_receiver/cast.framework.messages.TextTrackStyle) Value must not be null. |"]]
