diff --git a/404.html b/404.html index 5c5775875f..3deae0188b 100644 --- a/404.html +++ b/404.html @@ -1 +1 @@ -404: This page could not be found

404

This page could not be found.

\ No newline at end of file +404: This page could not be found

404

This page could not be found.

\ No newline at end of file diff --git a/_next/static/chunks/nextra-data-en-US.json b/_next/static/chunks/nextra-data-en-US.json index 93419e1386..79cf4a220e 100644 --- a/_next/static/chunks/nextra-data-en-US.json +++ b/_next/static/chunks/nextra-data-en-US.json @@ -1 +1 @@ -{"/component/ads":{"title":"Ads","data":{"ima-sdk#IMA SDK":"react-native-video has built-in support for Google IMA SDK for Android and iOS. To enable it please refer to installation section","usage#Usage":"To use AVOD, you need to pass adTagUrl prop to Video component. adTagUrl is a VAST uri.Example:\nadTagUrl=\"https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/vmap_ad_samples&sz=640x480&cust_params=sample_ar%3Dpremidpostoptimizedpodbumper&ciu_szs=300x250&gdfp_req=1&ad_rule=1&output=vmap&unviewed_position_start=1&env=vp&impl=s&cmsid=496&vid=short_onecue&correlator=\"\nNOTE: Video ads cannot start when you are using the PIP on iOS (more info available at Google IMA SDK Docs). If you are using custom controls, you must hide your PIP button when you receive the STARTED event from onReceiveAdEvent and show it again when you receive the ALL_ADS_COMPLETED event.","events#Events":"To receive events from IMA SDK, you need to pass onReceiveAdEvent prop to Video component. List of events, you can find hereExample:\n...\nonReceiveAdEvent={event => console.log(event)}\n..."}},"/component/drm":{"title":"DRM","data":{"":"Note: DRM is not supported on visionOS yet.","provide-drm-data-only-tested-with-httphttps-assets#Provide DRM data (only tested with http/https assets)":"You can provide some configuration to allow DRM playback.\nThis feature will disable the use of TextureView on Android.DRM object allows this members:\nProperty\tType\tDefault\tPlatform\tDescription\ttype\tDRMType\tundefined\tiOS/Android\tSpecifies which type of DRM you are going to use, DRMType is an enum exposed on the JS module ('fairplay', 'playready', ...)\tlicenseServer\tstring\tundefined\tiOS/Android\tSpecifies the license server URL\theaders\tObject\tundefined\tiOS/Android\tSpecifies the headers send to the license server URL on license acquisition\tcontentId\tstring\tundefined\tiOS\tSpecify the content id of the stream, otherwise it will take the host value from loadingRequest.request.URL.host (f.e: skd://testAsset -> will take testAsset)\tcertificateUrl\tstring\tundefined\tiOS\tSpecifies the url to obtain your ios certificate for fairplay, Url to the .cer file\tbase64Certificate\tbool\tfalse\tiOS\tSpecifies whether or not the certificate returned by the certificateUrl is on base64\tgetLicense\tfunction\tundefined\tiOS\tRather than setting the licenseServer url to get the license, you can manually get the license on the JS part, and send the result to the native part to configure FairplayDRM for the stream","base64certificate#base64Certificate":"Whether or not the certificate url returns it on base64.Platforms: iOS","certificateurl#certificateUrl":"URL to fetch a valid certificate for FairPlay.Platforms: iOS","getlicense#getLicense":"licenseServer and headers will be ignored. You will obtain as argument the SPC (as ASCII string, you will probably need to convert it to base 64) obtained from your contentId + the provided certificate via\n[loadingRequest streamingContentKeyRequestDataForApp:certificateData contentIdentifier:contentIdData options:nil error:&spcError];\nAlso, you will receive the contentId and a licenseUrl URL defined as loadingRequest.request.URL.absoluteString or as the licenseServer prop if it's passed.You should return on this method a CKC in Base64, either by just returning it or returning a Promise that resolves with the CKC.With this prop you can override the license acquisition flow, as an example:\ngetLicense: (spcString, contentId, licenseUrl) => {\n const base64spc = Base64.encode(spcString);\n const formData = new FormData();\n formData.append('spc', base64spc);\n return fetch(`https://license.pallycon.com/ri/licenseManager.do`, {\n method: 'POST',\n headers: {\n 'pallycon-customdata-v2': '==',\n 'Content-Type': 'application/x-www-form-urlencoded',\n },\n body: formData\n }).then(response => response.text()).then((response) => {\n return response;\n }).catch((error) => {\n console.error('Error', error);\n });\n}\nPlatforms: iOS","headers#headers":"You can customize headers send to the licenseServer.Example:\nsource={{\n uri: 'https://media.axprod.net/TestVectors/v7-MultiDRM-SingleKey/Manifest_1080p.mpd',\n}}\ndrm={{\n type: DRMType.WIDEVINE,\n licenseServer: 'https://drm-widevine-licensing.axtest.net/AcquireLicense',\n headers: {\n 'X-AxDRM-Message': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..FAbIiPxX8BHi9RwfzD7Yn-wugU19ghrkBFKsaCPrZmU'\n },\n}}","licenseserver#licenseServer":"The URL pointing to the licenseServer that will provide the authorization to play the protected stream.","type#type":"You can specify the DRM type, either by string or using the exported DRMType enum.\nValid values are, for Android: DRMType.WIDEVINE / DRMType.PLAYREADY / DRMType.CLEARKEY.\nfor iOS: DRMType.FAIRPLAY","common-usage-scenarios#Common Usage Scenarios":"","send-cookies-to-license-server#Send cookies to license server":"You can send Cookies to the license server via headers prop. Example:\ndrm: {\n type: DRMType.WIDEVINE\n licenseServer: 'https://drm-widevine-licensing.axtest.net/AcquireLicense',\n headers: {\n 'Cookie': 'PHPSESSID=etcetc; csrftoken=mytoken; _gat=1; foo=bar'\n },\n}","custom-license-acquisition-only-ios-for-now#Custom License Acquisition (only iOS for now)":"drm: {\n type: DRMType.FAIRPLAY,\n getLicense: (spcString) => {\n const base64spc = Base64.encode(spcString);\n return fetch('YOUR LICENSE SERVER HERE', {\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n Accept: 'application/json',\n },\n body: JSON.stringify({\n getFairplayLicense: {\n foo: 'bar',\n spcMessage: base64spc,\n }\n })\n })\n .then(response => response.json())\n .then((response) => {\n if (response && response.getFairplayLicenseResponse\n && response.getFairplayLicenseResponse.ckcResponse) {\n return response.getFairplayLicenseResponse.ckcResponse;\n }\n throw new Error('No correct response');\n })\n .catch((error) => {\n console.error('CKC error', error);\n });\n }\n}"}},"/component/events":{"title":"Events","data":{"":"This page shows the list of available callbacks to handle player notifications","list#List":"Name\tPlatforms Support\tonAudioBecomingNoisy\tAndroid, iOS\tonAudioFocusChanged\tAndroid\tonAudioTracks\tAndroid, iOS\tonBandwidthUpdate\tAndroid\tonBuffer\tAndroid, iOS\tonEnd\tAll\tonError\tAll\tonExternalPlaybackChange\tiOS\tonFullscreenPlayerWillPresent\tAndroid, iOS, visionOS\tonFullscreenPlayerDidPresent\tAndroid, iOS, visionOS\tonFullscreenPlayerWillDismiss\tAndroid, iOS, visionOS\tonFullscreenPlayerDidDismiss\tAndroid, iOS, visionOS\tonLoad\tAll\tonLoadStart\tAll\tonPictureInPictureStatusChanged\tiOS\tonPlaybackRateChange\tAll\tonPlaybackStateChanged\tAndroid, iOS, visionOS\tonProgress\tAll\tonReadyForDisplay\tAndroid, iOS\tonReceiveAdEvent\tAndroid, iOS\tonRestoreUserInterfaceForPictureInPictureStop\tiOS, visionOS\tonSeek\tAll\tonTimedMetadata\tAndroid, iOS, visionOS\tonTextTracks\tAndroid, iOS\tonVideoTracks\tAndroid\tonVolumeChange\tAndroid, iOS, visionOS","details#Details":"","onaudiobecomingnoisy#onAudioBecomingNoisy":"Callback function that is called when the audio is about to become 'noisy' due to a change in audio outputs. Typically this is called when audio output is being switched from an external source like headphones back to the internal speaker. It's a good idea to pause the media when this happens so the speaker doesn't start blasting sound.Payload: nonePlatforms: Android, iOS","onaudiofocuschanged#onAudioFocusChanged":"Callback function that is called when the audio focus changes. This is called when the audio focus is gained or lost. This is useful for determining if the media should be paused or not.Payload:\nProperty\tType\tDescription\thasAudioFocus\tboolean\tBoolean indicating whether the media has audio focus\t\nExample:\n{\n hasAudioFocus: true\n}","onaudiotracks#onAudioTracks":"Callback function that is called when audio tracks changePayload:An array of\nProperty\tType\tDescription\tindex\tnumber\tIndex number of the track\ttitle\tstring\tDescription of the track\tlanguage\tstring\t2 letter ISO 639-1 or 3 letter ISO 639-2 language code\ttype\tstring\tMime type of track\t\nExample:\n{\n audioTracks: [\n { language: 'es', title: 'Spanish', type: 'audio/mpeg', index: 0 },\n { language: 'en', title: 'English', type: 'audio/mpeg', index: 1 }\n ]\n}","onbandwidthupdate#onBandwidthUpdate":"Callback function that is called when the available bandwidth changes.Payload:\nProperty\tType\tDescription\tbitrate\tnumber\tThe estimated bitrate in bits/sec\twidth\tnumber\tThe width of the video (android only)\theight\tnumber\tThe height of the video (android only)\ttrackId\tstring\tThe track ID of the video track (android only)\t\nExample on iOS:\n{\n bitrate: 1000000\n}\nExample on Android:\n{\n bitrate: 1000000\n width: 1920\n height: 1080\n trackId: 'some-track-id'\n}\nNote: On Android, you must set the reportBandwidth prop to enable this event. This is due to the high volume of events generated.Platforms: Android","onbuffer#onBuffer":"Callback function that is called when the player buffers.Payload:\nProperty\tType\tDescription\tisBuffering\tboolean\tBoolean indicating whether buffering is active\t\nExample:\n{\n isBuffering: true\n}\nPlatforms: Android, iOS","onend#onEnd":"Callback function that is called when the player reaches the end of the media.Payload: nonePlatforms: all","onerror#onError":"Callback function that is called when the player experiences a playback error.Payload:\nProperty\tType\tDescription\terror\tobject\tObject containing properties with information about the error\t\nPlatforms: all","onexternalplaybackchange#onExternalPlaybackChange":"Callback function that is called when external playback mode for current playing video has changed. Mostly useful when connecting/disconnecting to Apple TV – it's called on connection/disconnection.Payload:\nProperty\tType\tDescription\tisExternalPlaybackActive\tboolean\tBoolean indicating whether external playback mode is active\t\nExample:\n{\n isExternalPlaybackActive: true\n}\nPlatforms: iOS","onfullscreenplayerwillpresent#onFullscreenPlayerWillPresent":"Callback function that is called when the player is about to enter fullscreen mode.Payload: nonePlatforms: Android, iOS","onfullscreenplayerdidpresent#onFullscreenPlayerDidPresent":"Callback function that is called when the player has entered fullscreen mode.Payload: nonePlatforms: Android, iOS","onfullscreenplayerwilldismiss#onFullscreenPlayerWillDismiss":"Callback function that is called when the player is about to exit fullscreen mode.Payload: nonePlatforms: Android, iOS","onfullscreenplayerdiddismiss#onFullscreenPlayerDidDismiss":"Callback function that is called when the player has exited fullscreen mode.Payload: nonePlatforms: Android, iOS","onload#onLoad":"Callback function that is called when the media is loaded and ready to play.Payload:\nProperty\tType\tDescription\tcurrentTime\tnumber\tTime in seconds where the media will start\tduration\tnumber\tLength of the media in seconds\tnaturalSize\tobject\tProperties: * width - Width in pixels that the video was encoded at * height - Height in pixels that the video was encoded at * orientation - \"portrait\" or \"landscape\"\taudioTracks\tarray\tAn array of audio track info objects with the following properties: * index - Index number * title - Description of the track * language - 2 letter ISO 639-1 or 3 letter ISO639-2 language code * type - Mime type of track\ttextTracks\tarray\tAn array of text track info objects with the following properties: * index - Index number * title - Description of the track * language - 2 letter ISO 639-1 or 3 letter ISO 639-2 language code * type - Mime type of track\tvideoTracks\tarray\tAn array of video track info objects with the following properties: * trackId - ID for the track * bitrate - Bit rate in bits per second * codecs - Comma separated list of codecs * height - Height of the video * width - Width of the video\t\nExample:\n{ \n canPlaySlowForward: true,\n canPlayReverse: false,\n canPlaySlowReverse: false,\n canPlayFastForward: false,\n canStepForward: false,\n canStepBackward: false,\n currentTime: 0,\n duration: 5910.208984375,\n naturalSize: {\n height: 1080\n orientation: 'landscape'\n width: '1920'\n },\n audioTracks: [\n { language: 'es', title: 'Spanish', type: 'audio/mpeg', index: 0 },\n { language: 'en', title: 'English', type: 'audio/mpeg', index: 1 }\n ],\n textTracks: [\n { title: '#1 French', language: 'fr', index: 0, type: 'text/vtt' },\n { title: '#2 English CC', language: 'en', index: 1, type: 'text/vtt' },\n { title: '#3 English Director Commentary', language: 'en', index: 2, type: 'text/vtt' }\n ],\n videoTracks: [\n { bitrate: 3987904, codecs: \"avc1.640028\", height: 720, trackId: \"f1-v1-x3\", width: 1280 },\n { bitrate: 7981888, codecs: \"avc1.640028\", height: 1080, trackId: \"f2-v1-x3\", width: 1920 },\n { bitrate: 1994979, codecs: \"avc1.4d401f\", height: 480, trackId: \"f3-v1-x3\", width: 848 }\n ]\n}\nPlatforms: all","onloadstart#onLoadStart":"Callback function that is called when the media starts loading.Payload:\nProperty\tDescription\tisNetwork\tboolean\tBoolean indicating if the media is being loaded from the network\ttype\tstring\tType of the media. Not available on Windows\turi\tstring\tURI for the media source. Not available on Windows\t\nExample:\n{\n isNetwork: true,\n type: '',\n uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8'\n}\nPlatforms: all","onplaybackstatechanged#onPlaybackStateChanged":"Callback function that is called when the playback state changes.Payload:\nProperty\tDescription\tisPlaying\tboolean\tBoolean indicating if the media is playing or not\t\nExample:\n{\n isPlaying: true,\n}\nPlatforms: Android, iOS","onpictureinpicturestatuschanged#onPictureInPictureStatusChanged":"Callback function that is called when picture in picture becomes active or inactive.\nProperty\tType\tDescription\tisActive\tboolean\tBoolean indicating whether picture in picture is active\t\nExample:\n{\nisActive: true\n}\nPlatforms: iOS","onplaybackratechange#onPlaybackRateChange":"Callback function that is called when the rate of playback changes - either paused or starts/resumes.\nProperty\tType\tDescription\tplaybackRate\tnumber\t0 when playback is paused, 1 when playing at normal speed. Other values when playback is slowed down or sped up\t\nExample:\n{\n playbackRate: 0, // indicates paused\n}\nPlatforms: all","onprogress#onProgress":"Callback function that is called every progressUpdateInterval milliseconds with info about which position the media is currently playing.\nProperty\tType\tDescription\tcurrentTime\tnumber\tCurrent position in seconds\tplayableDuration\tnumber\tPosition to where the media can be played to using just the buffer in seconds\tseekableDuration\tnumber\tPosition to where the media can be seeked to in seconds. Typically, the total length of the media\t\nExample:\n{\n currentTime: 5.2,\n playableDuration: 34.6,\n seekableDuration: 888\n}\nPlatforms: all","onreadyfordisplay#onReadyForDisplay":"Callback function that is called when the first video frame is ready for display. This is when the poster is removed.Payload: none\niOS: readyForDisplay\nAndroid STATE_READY\nPlatforms: Android, iOS, Web","onreceiveadevent#onReceiveAdEvent":"Callback function that is called when an AdEvent is received from the IMA's SDK.Enum AdEvent possible values for Android and iOS:\nEvent\tPlatform\tDescription\tAD_BREAK_ENDED\tiOS\tFired the first time each ad break ends. Applications must reenable seeking when this occurs (only used for dynamic ad insertion).\tAD_BREAK_READY\tAndroid, iOS\tFires when an ad rule or a VMAP ad break would have played if autoPlayAdBreaks is false.\tAD_BREAK_STARTED\tiOS\tFired first time each ad break begins playback. If an ad break is watched subsequent times this will not be fired. Applications must disable seeking when this occurs (only used for dynamic ad insertion).\tAD_BUFFERING\tAndroid\tFires when the ad has stalled playback to buffer.\tAD_CAN_PLAY\tAndroid\tFires when the ad is ready to play without buffering, either at the beginning of the ad or after buffering completes.\tAD_METADATA\tAndroid\tFires when an ads list is loaded.\tAD_PERIOD_ENDED\tiOS\tFired every time the stream switches from advertising or slate to content. This will be fired even when an ad is played a second time or when seeking into an ad (only used for dynamic ad insertion).\tAD_PERIOD_STARTED\tiOS\tFired every time the stream switches from content to advertising or slate. This will be fired even when an ad is played a second time or when seeking into an ad (only used for dynamic ad insertion).\tAD_PROGRESS\tAndroid\tFires when the ad's current time value changes. The event data will be populated with an AdProgressData object.\tALL_ADS_COMPLETED\tAndroid, iOS\tFires when the ads manager is done playing all the valid ads in the ads response, or when the response doesn't return any valid ads.\tCLICK\tAndroid, iOS\tFires when the ad is clicked.\tCOMPLETED\tAndroid, iOS\tFires when the ad completes playing.\tCONTENT_PAUSE_REQUESTED\tAndroid\tFires when content should be paused. This usually happens right before an ad is about to cover the content.\tCONTENT_RESUME_REQUESTED\tAndroid\tFires when content should be resumed. This usually happens when an ad finishes or collapses.\tCUEPOINTS_CHANGED\tiOS\tCuepoints changed for VOD stream (only used for dynamic ad insertion).\tDURATION_CHANGE\tAndroid\tFires when the ad's duration changes.\tERROR\tAndroid, iOS\tFires when an error occurred while loading the ad and prevent it from playing.\tFIRST_QUARTILE\tAndroid, iOS\tFires when the ad playhead crosses first quartile.\tIMPRESSION\tAndroid\tFires when the impression URL has been pinged.\tINTERACTION\tAndroid\tFires when an ad triggers the interaction callback. Ad interactions contain an interaction ID string in the ad data.\tLINEAR_CHANGED\tAndroid\tFires when the displayed ad changes from linear to nonlinear, or the reverse.\tLOADED\tAndroid, iOS\tFires when ad data is available.\tLOG\tAndroid, iOS\tFires when a non-fatal error is encountered. The user need not take any action since the SDK will continue with the same or next ad playback depending on the error situation.\tMIDPOINT\tAndroid, iOS\tFires when the ad playhead crosses midpoint.\tPAUSED\tAndroid, iOS\tFires when the ad is paused.\tRESUMED\tAndroid, iOS\tFires when the ad is resumed.\tSKIPPABLE_STATE_CHANGED\tAndroid\tFires when the displayed ads skippable state is changed.\tSKIPPED\tAndroid, iOS\tFires when the ad is skipped by the user.\tSTARTED\tAndroid, iOS\tFires when the ad starts playing.\tSTREAM_LOADED\tiOS\tStream request has loaded (only used for dynamic ad insertion).\tTAPPED\tiOS\tFires when the ad is tapped.\tTHIRD_QUARTILE\tAndroid, iOS\tFires when the ad playhead crosses third quartile.\tUNKNOWN\tiOS\tAn unknown event has fired\tUSER_CLOSE\tAndroid\tFires when the ad is closed by the user.\tVIDEO_CLICKED\tAndroid\tFires when the non-clickthrough portion of a video ad is clicked.\tVIDEO_ICON_CLICKED\tAndroid\tFires when a user clicks a video icon.\tVOLUME_CHANGED\tAndroid\tFires when the ad volume has changed.\tVOLUME_MUTED\tAndroid\tFires when the ad volume has been muted.\t\nPayload:\nProperty\tType\tDescription\tevent\tAdEvent\tThe ad event received\tdata\tRecord | undefined\tThe ad event data\t\nExample:\n{\n \"data\": {\n \"key\": \"value\"\n },\n \"event\": \"LOG\"\n}\nPlatforms: Android, iOS","onrestoreuserinterfaceforpictureinpicturestop#onRestoreUserInterfaceForPictureInPictureStop":"Callback function that corresponds to Apple's . Call inside of this function when done restoring the user interface.Payload: nonePlatforms: iOS","onseek#onSeek":"Callback function that is called when a seek completes.Payload:\nProperty\tType\tDescription\tcurrentTime\tnumber\tThe current time after the seek\tseekTime\tnumber\tThe requested time\t\nExample:\n{\n currentTime: 100.5\n seekTime: 100\n}\nBoth the currentTime & seekTime are reported because the video player may not seek to the exact requested position in order to improve seek performance.Platforms: Android, iOS, Windows UWP","ontimedmetadata#onTimedMetadata":"Callback function that is called when timed metadata becomes availablePayload:\nProperty\tType\tDescription\tmetadata\tarray\tArray of metadata objects\t\nExample:\n{\n metadata: [\n { value: 'Streaming Encoder', identifier: 'TRSN' },\n { value: 'Internet Stream', identifier: 'TRSO' },\n { value: 'Any Time You Like', identifier: 'TIT2' }\n ]\n}\nPlatforms: Android, iOS","ontexttracks#onTextTracks":"Callback function that is called when text tracks changePayload:\nProperty\tType\tDescription\tindex\tnumber\tInternal track ID\ttitle\tstring\tDescriptive name for the track\tlanguage\tstring\t2 letter ISO 639-1 code representing the language\ttype\tstring\tMime type of the track * TextTrackType.SRT - SubRip (.srt) * TextTrackType.TTML - TTML (.ttml) * TextTrackType.VTT - WebVTT (.vtt)iOS only supports VTT, Android supports all 3\tselected\tboolean\ttrue if track is playing\t\nExample:\n{\n textTracks: [\n {\n index: 0,\n title: 'Any Time You Like',\n type: 'srt',\n selected: true\n }\n ]\n}","ontexttrackdatachanged#onTextTrackDataChanged":"Callback function that is called when new subtitle data is available. It provides the actual subtitle content for the current selected text track, if available (mainly WebVTT).Payload:\nProperty\tType\tDescription\tsubtitleTracks\tstring\tThe subtitles text content in a compatible format.\t\nExample:\n{\n subtitleTracks: \"This blade has a dark past.\",\n}\nPlatforms: iOS","onvideotracks#onVideoTracks":"Callback function that is called when video tracks changePayload:\nProperty\tType\tDescription\ttrackId\tnumber\tInternal track ID\tcodecs\tstring\tMimeType of codec used for this track\twidth\tnumber\tTrack width\theight\tnumber\tTrack height\tbitrate\tnumber\tBitrate in bps\tselected\tboolean\ttrue if track is selected for playing\t\nExample:\n{\n videoTracks: [\n {\n trackId: 0,\n codecs: 'video/mp4',\n width: 1920,\n height: 1080,\n bitrate: 10000,\n selected: true\n }\n ]\n}\nPlatforms: Android","onvolumechange#onVolumeChange":"Callback function that is called when the volume of player changes.\nNote: This event applies to the volume of the player, not the volume of the device.\nPayload:\nProperty\tType\tDescription\tvolume\tnumber\tThe volume of the player (between 0 and 1)\t\nExample:\n{\n volume: 0.5\n}\nPlatforms: Android, iOS"}},"/component/methods":{"title":"Methods","data":{"":"This page shows the list of available methods","component-methods#Component methods":"Name\tPlatforms Support\tdismissFullscreenPlayer\tAndroid, iOS\tpresentFullscreenPlayer\tAndroid, iOS\tpause\tAndroid, iOS\tresume\tAndroid, iOS\tsave\tiOS\trestoreUserInterfaceForPictureInPictureStop\tiOS\tseek\tAll","dismissfullscreenplayer#dismissFullscreenPlayer":"dismissFullscreenPlayer(): PromiseTake the player out of fullscreen mode.Platforms: Android, iOS","presentfullscreenplayer#presentFullscreenPlayer":"presentFullscreenPlayer(): PromisePut the player in fullscreen mode.On iOS, this displays the video in a fullscreen view controller with controls.On Android, this puts the navigation controls in fullscreen mode. It is not a complete fullscreen implementation, so you will still need to apply a style that makes the width and height match your screen dimensions to get a fullscreen video.Platforms: Android, iOS","pause#pause":"pause(): PromisePause the video.Platforms: Android, iOS","resume#resume":"resume(): PromiseResume the video.Platforms: Android, iOS","save#save":"save(): Promise<{ uri: string }>Save video to your Photos with current filter prop. Returns promise.Notes:\nCurrently only supports highest quality export\nCurrently only supports MP4 export\nCurrently only supports exporting to user's cache directory with a generated UUID filename.\nUser will need to remove the saved video through their Photos app\nWorks with cached videos as well. (Checkout video-caching example)\nIf the video is has not began buffering (e.g. there is no internet connection) then the save function will throw an error.\nIf the video is buffering then the save function promise will return after the video has finished buffering and processing.\nFuture:\nWill support multiple qualities through options\nWill support more formats in the future through options\nWill support custom directory and file name through options\nPlatforms: iOS","restoreuserinterfaceforpictureinpicturestopcompleted#restoreUserInterfaceForPictureInPictureStopCompleted":"(restored)This function corresponds to the completion handler in Apple's restoreUserInterfaceForPictureInPictureStop. IMPORTANT: This function must be called after onRestoreUserInterfaceForPictureInPictureStop is called.Platforms: iOS","seek#seek":"seek(seconds)Seek to the specified position represented by seconds. seconds is a float value.seek() can only be called after the onLoad event has fired. Once completed, the onSeek event will be called.Platforms: all","exact-seek#Exact seek":"By default iOS seeks within 100 milliseconds of the target position. If you need more accuracy, you can use the seek with tolerance method:seek(seconds, tolerance)tolerance is the max distance in milliseconds from the seconds position that's allowed. Using a more exact tolerance can cause seeks to take longer. If you want to seek exactly, set tolerance to 0.Platforms: iOS","example-usage#Example Usage":"const videoRef = useRef(null);\nconst someCoolFunctions = async () => {\n if(!videoRef.current) {\n return;\n }\n // present or dismiss fullscreen player\n videoRef.current.presentFullscreenPlayer();\n videoRef.current.dismissFullscreenPlayer();\n // pause or play the video\n videoRef.current.play();\n videoRef.current.pause();\n // save video to your Photos with current filter prop\n const response = await videoRef.current.save();\n const path = response.uri;\n // seek to the specified position represented by seconds\n videoRef.current.seek(200);\n // or on iOS you can seek with tolerance\n videoRef.current.seek(200, 10);\n};\nreturn (\n \n);","static-methods#Static methods":"","getwidevinelevel#getWidevineLevel":"Indicates whether the widevine level supported by device.Possible values are:\n0 - unable to determine widevine support (typically not supported)\n1, 2, 3 - Widevine level supported\nPlatform: Android","iscodecsupported#isCodecSupported":"Indicates whether the provided codec is supported level supported by device.parameters:\nmimetype: mime type of codec to query\nwidth, height: resolution to query\nPossible results:\nhardware - codec is supported by hardware\nsoftware - codec is supported by software only\nunsupported - codec is not supported\nPlatform: Android","ishevcsupported#isHEVCSupported":"Helper which Indicates whether the provided HEVC/1920*1080 is supported level supported by device. It uses isCodecSupported internally.Platform: Android","example-usage-1#Example Usage":"import { VideoDecoderProperties } from 'react-native-video';\nVideoDecoderProperties.getWidevineLevel().then((level) => {\n ...\n});\nVideoDecoderProperties.isCodecSupported('video/hevc', 1920, 1080).then((support) => {\n ...\n});\nVideoDecoderProperties.isHEVCSupported().then((support) => {\n ...\n});"}},"/component/props":{"title":"Configurable props","data":{"":"This page shows the list of available properties to configure player","list#List":"Name\tPlatforms Support\tadTagUrl\tAndroid, iOS\tallowsExternalPlayback\tiOS\taudioOnly\tAll\taudioOutput\tAndroid, iOS, visionOS\tautomaticallyWaitsToMinimizeStalling\tiOS, visionOS\tbackBufferDurationMs\tAndroid\tbufferConfig\tAndroid\tcontentStartTime\tAndroid\tcontrols\tAndroid, iOS, visionOS\tcurrentPlaybackTime\tAndroid\tdebug\tAndroid\tdisableFocus\tAndroid\tdisableDisconnectError\tAndroid\tfilter\tiOS, visionOS\tfilterEnabled\tiOS, visionOS\tfocusable\tAndroid\tfullscreen\tAndroid, iOS\tfullscreenAutorotate\tiOS, visionOS\tfullscreenOrientation\tiOS, visionOS\theaders\tAndroid\thideShutterView\tAndroid\tignoreSilentSwitch\tiOS, visionOS\tmaxBitRate\tAndroid, iOS, visionOS\tminLoadRetryCount\tAndroid\tmixWithOthers\tiOS, visionOS\tmuted\tAll\tpaused\tAll\tpictureInPicture\tiOS\tplayInBackground\tAndroid, iOS, visionOS\tplayWhenInactive\tiOS, visionOS\tposter\tAll\tposterResizeMode\tAll\tpreferredForwardBufferDuration\tiOS, visionOS\tpreventsDisplaySleepDuringVideoPlayback\tiOS, Android\tprogressUpdateInterval\tAll\trate\tAll\trepeat\tAll\treportBandwidth\tAndroid\tresizeMode\tAll\tselectedAudioTrack\tAndroid, iOS, visionOS\tselectedTextTrack\tAndroid, iOS visionOS\tselectedVideoTrack\tAndroid\tshutterColor\tAndroid\tsource\tAll\tsubtitleStyle\tAndroid\ttextTracks\tAndroid, iOS, visionOS\ttrackId\tAndroid\tuseTextureView\tAndroid\tuseSecureView\tAndroid\tvolume\tAll\tlocalSourceEncryptionKeyScheme\tAll","details#Details":"","adtagurl#adTagUrl":"Sets the VAST uri to play AVOD ads.Example:\nadTagUrl=\"https://pubads.g.doubleclick.net/gampad/ads?iu=/21775744923/external/vmap_ad_samples&sz=640x480&cust_params=sample_ar%3Dpremidpostoptimizedpodbumper&ciu_szs=300x250&gdfp_req=1&ad_rule=1&output=vmap&unviewed_position_start=1&env=vp&impl=s&cmsid=496&vid=short_onecue&correlator=\"\nNote: You need enable IMA SDK in gradle or pod file - enable client side ads insertionPlatforms: Android, iOS","allowsexternalplayback#allowsExternalPlayback":"Indicates whether the player allows switching to external playback mode such as AirPlay or HDMI.\ntrue (default) - allow switching to external playback mode\nfalse - Don't allow switching to external playback mode\nPlatforms: iOS","audioonly#audioOnly":"Indicates whether the player should only play the audio track and instead of displaying the video track, show the poster instead.\nfalse (default) - Display the video as normal\ntrue - Show the poster and play the audio\nFor this to work, the poster prop must be set.Platforms: all","audiooutput#audioOutput":"Changes the audio output.\nspeaker (default) - plays through speaker\nearpiece - plays through earpiece\nPlatforms: Android, iOS, visionOS","automaticallywaitstominimizestalling#automaticallyWaitsToMinimizeStalling":"A Boolean value that indicates whether the player should automatically delay playback in order to minimize stalling. For clients linked against iOS 10.0 and later\nfalse - Immediately starts playback\ntrue (default) - Delays playback in order to minimize stalling\nPlatforms: iOS, visionOS","backbufferdurationms#backBufferDurationMs":"The number of milliseconds of buffer to keep before the current position. This allows rewinding without rebuffering within that duration.Platforms: Android","bufferconfig#bufferConfig":"Adjust the buffer settings. This prop takes an object with one or more of the properties listed below.\nProperty\tType\tDescription\tminBufferMs\tnumber\tThe default minimum duration of media that the player will attempt to ensure is buffered at all times, in milliseconds.\tmaxBufferMs\tnumber\tThe default maximum duration of media that the player will attempt to buffer, in milliseconds.\tbufferForPlaybackMs\tnumber\tThe default duration of media that must be buffered for playback to start or resume following a user action such as a seek, in milliseconds.\tbufferForPlaybackAfterRebufferMs\tnumber\tThe default duration of media that must be buffered for playback to resume after a rebuffer, in milliseconds. A rebuffer is defined to be caused by buffer depletion rather than a user action.\tmaxHeapAllocationPercent\tnumber\tThe percentage of available heap that the video can use to buffer, between 0 and 1\tminBackBufferMemoryReservePercent\tnumber\tThe percentage of available app memory at which during startup the back buffer will be disabled, between 0 and 1\tminBufferMemoryReservePercent\tnumber\tThe percentage of available app memory to keep in reserve that prevents buffer from using it, between 0 and 1\t\nThis prop should only be set when you are setting the source, changing it after the media is loaded will cause it to be reloaded.Example with default values:\nbufferConfig={{\n minBufferMs: 15000,\n maxBufferMs: 50000,\n bufferForPlaybackMs: 2500,\n bufferForPlaybackAfterRebufferMs: 5000\n}}\nPlatforms: Android","chapters#chapters":"To provide a custom chapter source for tvOS. This prop takes an array of objects with the properties listed below.\nProperty\tType\tDescription\ttitle\tstring\tThe title of the chapter to create\tstartTime\tnumber\tThe start time of the chapter in seconds\tendTime\tnumber\tThe end time of the chapter in seconds\turi\tstring?\tOptional: Provide an http orl or the some base64 string to override the image of the chapter. For some media files the images are generated automatically\t\nPlatforms: tvOS","currentplaybacktime#currentPlaybackTime":"When playing an HLS live stream with a EXT-X-PROGRAM-DATE-TIME tag configured, then this property will contain the epoch value in msec.Platforms: Android, iOS","controls#controls":"Determines whether to show player controls.\nfalse (default) - Don't show player controls\ntrue - Show player controls\nNote on iOS, controls are always shown when in fullscreen mode.\nNote on Android, native controls are available by default.\nIf needed, you can also add your controls or use a package like react-native-video-controls or react-native-media-console, see Useful Side Project.Platforms: Android, iOS, visionOS","contentstarttime#contentStartTime":"The start time in ms for SSAI content. This determines at what time to load the video info like resolutions. Use this only when you have SSAI stream where ads resolution is not the same as content resolution.Platforms: Android","debug#debug":"Enable more verbosity in logs.\n[!WARNING]\nDo not use this open in production build\nProperty\tType\tDescription\tenable\tboolean\twhen true, display logs with verbosity higher\tthread\tboolean\tenable thread display\t\nExample with default values:\ndebug={{\n enable: true,\n thread: true,\n}}\nPlatforms: Android","disablefocus#disableFocus":"Determines whether video audio should override background music/audio in Android devices.\nfalse (default) - Override background audio/music\ntrue - Let background audio/music from other apps play\nNote: Allows multiple videos to play if set to true. If false, when one video is playing and another is started, the first video will be paused.Platforms: Android","disabledisconnecterror#disableDisconnectError":"Determines if the player needs to throw an error when connection is lost or not\nfalse (default) - Player will throw an error when connection is lost\ntrue - Player will keep trying to buffer when network connect is lost\nPlatforms: Android","drm#DRM":"To setup DRM please follow this guidePlatforms: Android, iOS\n⚠️ DRM is not supported on visionOS yet","filter#filter":"Add video filter\nFilterType.NONE (default) - No Filter\nFilterType.INVERT - CIColorInvert\nFilterType.MONOCHROME - CIColorMonochrome\nFilterType.POSTERIZE - CIColorPosterize\nFilterType.FALSE - CIFalseColor\nFilterType.MAXIMUMCOMPONENT - CIMaximumComponent\nFilterType.MINIMUMCOMPONENT - CIMinimumComponent\nFilterType.CHROME - CIPhotoEffectChrome\nFilterType.FADE - CIPhotoEffectFade\nFilterType.INSTANT - CIPhotoEffectInstant\nFilterType.MONO - CIPhotoEffectMono\nFilterType.NOIR - CIPhotoEffectNoir\nFilterType.PROCESS - CIPhotoEffectProcess\nFilterType.TONAL - CIPhotoEffectTonal\nFilterType.TRANSFER - CIPhotoEffectTransfer\nFilterType.SEPIA - CISepiaTone\nFor more details on these filters refer to the iOS docs.Notes:\nUsing a filter can impact CPU usage. A workaround is to save the video with the filter and then load the saved video.\nVideo filter is currently not supported on HLS playlists.\nfilterEnabled must be set to true\nPlatforms: iOS, visionOS","filterenabled#filterEnabled":"Enable video filter.\nfalse (default) - Don't enable filter\ntrue - Enable filter\nPlatforms: iOS, visionOS","focusable#Focusable":"Whether this video view should be focusable with a non-touch input device, eg. receive focus with a hardware keyboard.\nfalse - Makes view unfocusable\ntrue (default) - Makes view focusable\nPlatforms: Android","fullscreen#fullscreen":"Controls whether the player enters fullscreen on play.\nSee presentFullscreenPlayer for details.\nfalse (default) - Don't display the video in fullscreen\ntrue - Display the video in fullscreen\nPlatforms: iOS, Android, visionOS","fullscreenautorotate#fullscreenAutorotate":"If a preferred fullscreenOrientation is set, causes the video to rotate to that orientation but permits rotation of the screen to orientation held by user. Defaults to TRUE.Platforms: iOS, visionOS","fullscreenorientation#fullscreenOrientation":"all (default) -\nlandscape\nportrait\nPlatforms: iOS, visionOS","headers#headers":"Pass headers to the HTTP client. Can be used for authorization. Headers must be a part of the source object.Example:\nsource={{\n uri: \"https://www.example.com/video.mp4\",\n headers: {\n Authorization: 'bearer some-token-value',\n 'X-Custom-Header': 'some value'\n }\n}}\nPlatforms: Android","hideshutterview#hideShutterView":"Controls whether the ExoPlayer shutter view (black screen while loading) is enabled.\nfalse (default) - Show shutter view\ntrue - Hide shutter view\nPlatforms: Android","ignoresilentswitch#ignoreSilentSwitch":"Controls the iOS silent switch behavior\n\"inherit\" (default) - Use the default AVPlayer behavior\n\"ignore\" - Play audio even if the silent switch is set\n\"obey\" - Don't play audio if the silent switch is set\nPlatforms: iOS, visionOS","maxbitrate#maxBitRate":"Sets the desired limit, in bits per second, of network bandwidth consumption when multiple video streams are available for a playlist.Default: 0. Don't limit the maxBitRate.Example:\nmaxBitRate={2000000} // 2 megabits\nPlatforms: Android, iOS, visionOS","minloadretrycount#minLoadRetryCount":"Sets the minimum number of times to retry loading data before failing and reporting an error to the application. Useful to recover from transient internet failures.Default: 3. Retry 3 times.Example:\nminLoadRetryCount={5} // retry 5 times\nPlatforms: Android","mixwithothers#mixWithOthers":"Controls how Audio mix with other apps.\n\"inherit\" (default) - Use the default AVPlayer behavior\n\"mix\" - Audio from this video mixes with audio from other apps.\n\"duck\" - Reduces the volume of other apps while audio from this video plays.\nPlatforms: iOS, visionOS","muted#muted":"Controls whether the audio is muted\nfalse (default) - Don't mute audio\ntrue - Mute audio\nPlatforms: all","paused#paused":"Controls whether the media is paused\nfalse (default) - Don't pause the media\ntrue - Pause the media\nPlatforms: all","pictureinpicture#pictureInPicture":"Determine whether the media should played as picture in picture.\nfalse (default) - Don't not play as picture in picture\ntrue - Play the media as picture in picture\nNOTE: Video ads cannot start when you are using the PIP on iOS (more info available at Google IMA SDK Docs). If you are using custom controls, you must hide your PIP button when you receive the STARTED event from onReceiveAdEvent and show it again when you receive the ALL_ADS_COMPLETED event.Platforms: iOS","playinbackground#playInBackground":"Determine whether the media should continue playing while the app is in the background. This allows customers to continue listening to the audio.\nfalse (default) - Don't continue playing the media\ntrue - Continue playing the media\nTo use this feature on iOS, you must:\nEnable Background Audio in your Xcode project\nSet the ignoreSilentSwitch prop to \"ignore\"\nPlatforms: Android, iOS, visionOS","playwheninactive#playWhenInactive":"Determine whether the media should continue playing when notifications or the Control Center are in front of the video.\nfalse (default) - Don't continue playing the media\ntrue - Continue playing the media\nPlatforms: iOS, visionOS","poster#poster":"An image to display while the video is loading\nValue: string with a URL for the poster, e.g. \"https://baconmockup.com/300/200/\"Platforms: all","posterresizemode#posterResizeMode":"Determines how to resize the poster image when the frame doesn't match the raw video dimensions.\n\"contain\" (default) - Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or less than the corresponding dimension of the view (minus padding).\n\"center\" - Center the image in the view along both dimensions. If the image is larger than the view, scale it down uniformly so that it is contained in the view.\n\"cover\" - Scale the image uniformly (maintain the image's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding).\n\"none\" - Don't apply resize\n\"repeat\" - Repeat the image to cover the frame of the view. The image will keep its size and aspect ratio. (iOS only)\n\"stretch\" - Scale width and height independently, This may change the aspect ratio of the src.\nPlatforms: all","preferredforwardbufferduration#preferredForwardBufferDuration":"The duration the player should buffer media from the network ahead of the playhead to guard against playback disruption. Sets the preferredForwardBufferDuration instance property on AVPlayerItem.Default: 0Platforms: iOS, visionOS","preventsdisplaysleepduringvideoplayback#preventsDisplaySleepDuringVideoPlayback":"Controls whether or not the display should be allowed to sleep while playing the video. Default is not to allow display to sleep.Default: truePlatforms: iOS, Android","progressupdateinterval#progressUpdateInterval":"Delay in milliseconds between onProgress events in milliseconds.Default: 250.0Platforms: all","rate#rate":"Speed at which the media should play.\n0.0 - Pauses the video\n1.0 - Play at normal speed\nOther values - Slow down or speed up playback\nPlatforms: all","repeat#repeat":"Determine whether to repeat the video when the end is reached\nfalse (default) - Don't repeat the video\ntrue - Repeat the video\nPlatforms: all","onaudiotracks#onAudioTracks":"Callback function that is called when audio tracks changePayload:\nProperty\tType\tDescription\tindex\tnumber\tInternal track ID\ttitle\tstring\tDescriptive name for the track\tlanguage\tstring\t2 letter ISO 639-1 code representing the language\tbitrate\tnumber\tbitrate of track\ttype\tstring\tMime type of track\tselected\tboolean\ttrue if track is playing\t\nExample:\n{\n audioTracks: [\n { language: 'es', title: 'Spanish', type: 'audio/mpeg', index: 0, selected: true },\n { language: 'en', title: 'English', type: 'audio/mpeg', index: 1 }\n ],\n}\nPlatforms: Android","reportbandwidth#reportBandwidth":"Determine whether to generate onBandwidthUpdate events. This is needed due to the high frequency of these events on ExoPlayer.\nfalse (default) - Don't generate onBandwidthUpdate events\ntrue - Generate onBandwidthUpdate events\nPlatforms: Android","resizemode#resizeMode":"Determines how to resize the video when the frame doesn't match the raw video dimensions.\n\"none\" (default) - Don't apply resize\n\"contain\" - Scale the video uniformly (maintain the video's aspect ratio) so that both dimensions (width and height) of the video will be equal to or less than the corresponding dimension of the view (minus padding).\n\"cover\" - Scale the video uniformly (maintain the video's aspect ratio) so that both dimensions (width and height) of the image will be equal to or larger than the corresponding dimension of the view (minus padding).\n\"stretch\" - Scale width and height independently, This may change the aspect ratio of the src.\nPlatforms: Android, iOS, Windows UWP","selectedaudiotrack#selectedAudioTrack":"Configure which audio track, if any, is played.\nselectedAudioTrack={{\n type: Type,\n value: Value\n}}\nExample:\nselectedAudioTrack={{\n type: \"title\",\n value: \"Dubbing\"\n}}\nType\tValue\tDescription\t\"system\" (default)\tN/A\tPlay the audio track that matches the system language. If none match, play the first track.\t\"disabled\"\tN/A\tTurn off audio\t\"title\"\tstring\tPlay the audio track with the title specified as the Value, e.g. \"French\"\t\"language\"\tstring\tPlay the audio track with the language specified as the Value, e.g. \"fr\"\t\"index\"\tnumber\tPlay the audio track with the index specified as the value, e.g. 0\t\nIf a track matching the specified Type (and Value if appropriate) is unavailable, the first audio track will be played. If multiple tracks match the criteria, the first match will be used.Platforms: Android, iOS, visionOS","selectedtexttrack#selectedTextTrack":"Configure which text track (caption or subtitle), if any, is shown.\nselectedTextTrack={{\n type: Type,\n value: Value\n}}\nExample:\nselectedTextTrack={{\n type: \"title\",\n value: \"English Subtitles\"\n}}\nType\tValue\tDescription\t\"system\" (default)\tN/A\tDisplay captions only if the system preference for captions is enabled\t\"disabled\"\tN/A\tDon't display a text track\t\"title\"\tstring\tDisplay the text track with the title specified as the Value, e.g. \"French 1\"\t\"language\"\tstring\tDisplay the text track with the language specified as the Value, e.g. \"fr\"\t\"index\"\tnumber\tDisplay the text track with the index specified as the value, e.g. 0\t\nBoth iOS & Android (only 4.4 and higher) offer Settings to enable Captions for hearing impaired people. If \"system\" is selected and the Captions Setting is enabled, iOS/Android will look for a caption that matches that customer's language and display it.If a track matching the specified Type (and Value if appropriate) is unavailable, no text track will be displayed. If multiple tracks match the criteria, the first match will be used.Platforms: Android, iOS, visionOS","selectedvideotrack#selectedVideoTrack":"Configure which video track should be played. By default, the player uses Adaptive Bitrate Streaming to automatically select the stream it thinks will perform best based on available bandwidth.\nselectedVideoTrack={{\n type: Type,\n value: Value\n}}\nExample:\nselectedVideoTrack={{\n type: \"resolution\",\n value: 480\n}}\nType\tValue\tDescription\t\"auto\" (default)\tN/A\tLet the player determine which track to play using ABR\t\"disabled\"\tN/A\tTurn off video\t\"resolution\"\tnumber\tPlay the video track with the height specified, e.g. 480 for the 480p stream\t\"index\"\tnumber\tPlay the video track with the index specified as the value, e.g. 0\t\nIf a track matching the specified Type (and Value if appropriate) is unavailable, ABR will be used.Platforms: Android","shuttercolor#shutterColor":"Apply color to shutter view, if you see black flashes before video start then set\nshutterColor='transparent'\nblack (default)\nPlatforms: Android","source#source":"Sets the media source. You can pass an asset loaded via require or an object with a uri.Setting the source will trigger the player to attempt to load the provided media with all other given props. Please be sure that all props are provided before/at the same time as setting the source.Rendering the player component with a null source will init the player, and start playing once a source value is provided.Providing a null source value after loading a previous source will stop playback, and clear out the previous source content.The docs for this prop are incomplete and will be updated as each option is investigated and tested.","asset-loaded-via-require#Asset loaded via require":"⚠️ on iOS, you file name must not contain spaces eg. my video.mp4 will not work, use my-video.mp4 instead\nExample:\nconst sintel = require('./sintel.mp4');\nsource={sintel}","uri-string#URI string":"A number of URI schemes are supported by passing an object with a uri attribute.All uri string shall be url encoded.\nFor exemple 'www.myurl.com/blabla?q=test uri' is invalid, where 'www.myurl.com/blabla?q=test%20uri' is valid","web-address-http-https#Web address (http://, https://)":"Example:\nsource={{uri: 'https://www.sample-videos.com/video/mp4/720/big_buck_bunny_720p_10mb.mp4' }}\nPlatforms: all","file-path-file#File path (file://)":"Example:\nsource={{ uri: 'file:///sdcard/Movies/sintel.mp4' }}\nNote: Your app will need to request permission to read external storage if you're accessing a file outside your app.Platforms: Android, possibly others","ipod-library-ipod-library#iPod Library (ipod-library://)":"Path to a sound file in your iTunes library. Typically shared from iTunes to your app.Example:\nsource={{ uri: 'ipod-library:///path/to/music.mp3' }}\nNote: Using this feature adding an entry for NSAppleMusicUsageDescription to your Info.plist file as described herePlatforms: iOS","explicit-mimetype-for-the-stream#Explicit mimetype for the stream":"Provide a member type with value (mpd/m3u8/ism) inside the source object.\nSometimes is needed when URL extension does not match with the mimetype that you are expecting, as seen on the next example. (Extension is .ism -smooth streaming- but file served is on format mpd -mpeg dash-)Example:\nsource={{ uri: 'http://host-serving-a-type-different-than-the-extension.ism/manifest(format=mpd-time-csf)',\ntype: 'mpd' }}","other-protocols#Other protocols":"The following other types are supported on some platforms, but aren't fully documented yet:\ncontent://, ms-appx://, ms-appdata://, assets-library://","start-playback-at-a-specific-point-in-time#Start playback at a specific point in time":"Provide an optional startPosition for video. Value is in milliseconds. If the cropStart prop is applied, it will be applied from that point forward.\n(If it is negative or undefined or null, it is ignored)Platforms: Android, iOS","playing-only-a-portion-of-the-video-start--end-time#Playing only a portion of the video (start & end time)":"Provide an optional cropStart and/or cropEnd for the video. Value is in milliseconds. Useful when you want to play only a portion of a large video.Example\nsource={{ uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8', cropStart: 36012, cropEnd: 48500 }}\nsource={{ uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8', cropStart: 36012 }}\nsource={{ uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8', cropEnd: 48500 }}\nPlatforms: iOS, Android","overriding-the-metadata-of-a-source#Overriding the metadata of a source":"Provide an optional title, subtitle, customImageUri and/or description properties for the video.\nUseful when to adapt the tvOS playback experience.Example:\nsource={{ \n uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8', \n title: 'Custom Title', \n subtitle: 'Custom Subtitle', \n description: 'Custom Description',\n customImageUri: 'https://pbs.twimg.com/profile_images/1498641868397191170/6qW2XkuI_400x400.png'\n }}\nPlatforms: tvOS","subtitlestyle#subtitleStyle":"Property\tDescription\tPlatforms\tfontSize\tAdjust the font size of the subtitles. Default: font size of the device\tAndroid\tpaddingTop\tAdjust the top padding of the subtitles. Default: 0\tAndroid\tpaddingBottom\tAdjust the bottom padding of the subtitles. Default: 0\tAndroid\tpaddingLeft\tAdjust the left padding of the subtitles. Default: 0\tAndroid\tpaddingRight\tAdjust the right padding of the subtitles. Default: 0\tAndroid\t\nExample:\nsubtitleStyle={{ paddingBottom: 50, fontSize: 20 }}","texttracks#textTracks":"Load one or more \"sidecar\" text tracks. This takes an array of objects representing each track. Each object should have the format:\n⚠️ This feature does not work with HLS playlists (e.g m3u8) on iOS\nProperty\tDescription\ttitle\tDescriptive name for the track\tlanguage\t2 letter ISO 639-1 code representing the language\ttype\tMime type of the track * TextTrackType.SRT - SubRip (.srt) * TextTrackType.TTML - TTML (.ttml) * TextTrackType.VTT - WebVTT (.vtt)iOS only supports VTT, Android supports all 3\turi\tURL for the text track. Currently, only tracks hosted on a webserver are supported\t\nOn iOS, sidecar text tracks are only supported for individual files, not HLS playlists. For HLS, you should include the text tracks as part of the playlist.Note: Due to iOS limitations, sidecar text tracks are not compatible with Airplay. If textTracks are specified, AirPlay support will be automatically disabled.Example:\nimport { TextTrackType }, Video from 'react-native-video';\ntextTracks={[\n {\n title: \"English CC\",\n language: \"en\",\n type: TextTrackType.VTT, // \"text/vtt\"\n uri: \"https://bitdash-a.akamaihd.net/content/sintel/subtitles/subtitles_en.vtt\"\n },\n {\n title: \"Spanish Subtitles\",\n language: \"es\",\n type: TextTrackType.SRT, // \"application/x-subrip\"\n uri: \"https://durian.blender.org/wp-content/content/subtitles/sintel_es.srt\"\n }\n]}\nPlatforms: Android, iOS, visionOS","trackid#trackId":"Configure an identifier for the video stream to link the playback context to the events emitted.Platforms: Android","usetextureview#useTextureView":"Controls whether to output to a TextureView or SurfaceView.SurfaceView is more efficient and provides better performance but has two limitations:\nIt can't be animated, transformed or scaled\nYou can't overlay multiple SurfaceViews\nuseTextureView can only be set at same time you're setting the source.\ntrue (default) - Use a TextureView\nfalse - Use a SurfaceView\nPlatforms: Android","usesecureview#useSecureView":"Force the output to a SurfaceView and enables the secure surface.This will override useTextureView flag.SurfaceView is is the only one that can be labeled as secure.\ntrue - Use security\nfalse (default) - Do not use security\nPlatforms: Android","volume#volume":"Adjust the volume.\n1.0 (default) - Play at full volume\n0.0 - Mute the audio\nOther values - Reduce volume\nPlatforms: all","localsourceencryptionkeyscheme#localSourceEncryptionKeyScheme":"Set the url scheme for stream encryption key for local assetsType: StringExample:\nlocalSourceEncryptionKeyScheme=\"my-offline-key\"\nPlatforms: iOS"}},"/installation":{"title":"Installation","data":{"":"Using npm:\nnpm install --save react-native-video\nor using yarn:\nyarn add react-native-video\nThen follow the instructions for your platform to link react-native-video into your project","ios#iOS":"","standard-method#Standard Method":"","enable-custom-feature-in-podfile-file#Enable custom feature in podfile file":"Samples available in sample app see sample pod file","video-caching#Video caching":"To enable Video caching usage, add following line in your podfile:\n(more info here)\n# enable Video caching\n+ $RNVideoUseVideoCaching=true","google-ima#Google IMA":"Google IMA is the google SDK to support Client Side Ads Integration (CSAI), see google documentation for more information.To enable google IMA usage define add following line in your podfile:\n$RNVideoUseGoogleIMA=true","android#Android":"From version >= 6.0.0, your application needs to have kotlin version >= 1.7.0\nbuildscript {\n ...\n ext.kotlinVersion = '1.7.0'\n ...\n}","enable-custom-feature-in-gradle-file#Enable custom feature in gradle file":"","enable-client-side-ads-insertion#Enable client side ads insertion":"To enable client side ads insertion CSAI with google IMA SDK, you need to enable it in your gradle file.\nbuildscript {\n ext {\n ...\n RNVUseExoplayerIMA = true\n ...\n }\n}\nSee sample app","windows#Windows":"","autolinking#Autolinking":"React Native Windows 0.63 and aboveAutolinking should automatically add react-native-video to your app.","manual-linking#Manual Linking":"React Native Windows 0.62Make the following additions to the given files manually:windows\\myapp.slnAdd the ReactNativeVideoCPP project to your solution (eg. windows\\myapp.sln):\nOpen your solution in Visual Studio 2019\nRight-click Solution icon in Solution Explorer > Add > Existing Project...\nSelect node_modules\\react-native-video\\windows\\ReactNativeVideoCPP\\ReactNativeVideoCPP.vcxproj\nwindows\\myapp\\myapp.vcxprojAdd a reference to ReactNativeVideoCPP to your main application project (eg. windows\\myapp\\myapp.vcxproj):\nOpen your solution in Visual Studio 2019\nRight-click main application project > Add > Reference...\nCheck ReactNativeVideoCPP from Solution Projects\npch.hAdd #include \"winrt/ReactNativeVideoCPP.h\".app.cppAdd PackageProviders().Append(winrt::ReactNativeVideoCPP::ReactPackageProvider()); before InitializeComponent();.React Native Windows 0.61 and belowFollow the manual linking instructions for React Native Windows 0.62 above, but substitute ReactNativeVideoCPP61 for ReactNativeVideoCPP.","tvos#tvOS":"react-native link react-native-video doesn’t work properly with the tvOS target so we need to add the library manually.First select your project in Xcode.After that, select the tvOS target of your application and select « General » tabScroll to « Linked Frameworks and Libraries » and tap on the + buttonSelect RCTVideo-tvOS","visionos#visionOS":"Add patch for promises pods to your pod files to make it work with visionOS target.\nThis patch is required only for visionOS target and will be removed in future.\n+ pod 'PromisesSwift', :podspec => '../node_modules/react-native-video/ios/patches/PromisesSwift.podspec'\n+ pod 'PromisesObjC', :podspec => '../node_modules/react-native-video/ios/patches/PromisesObjC.podspec'\nRemember to run pod install after adding this patch.After this you can follow the same steps as for iOS target.","examples#Examples":"Run yarn xbasic install in the root directory before running any of the examples.","ios-example#iOS Example":"yarn xbasic ios","android-example#Android Example":"yarn xbasic android","windows-example#Windows Example":"yarn xbasic windows"}},"/":{"title":"A