BIS fnc playVideo: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects? in MP|Multiplayer Effects(...) |
m (note about black bars) |
||
(23 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=function | ||
| arma2oa | |game1= arma2oa | ||
|version1= 1.56 | |||
|1. | |game2= tkoh | ||
|version2= 1.00 | |||
|game3= arma3 | |||
|version3= 0.50 | |||
|gr1= GUI | |gr1= GUI | ||
|eff= local | |||
| Plays in-game video with a range of options. The function can be [[call]]ed or [[spawn]]ed. If [[spawn]]ed, [[scriptDone]] command can be used to see if video is stopped or finished. If [[call]]ed in scheduled environment, the next line of code will not process until the video is stopped or finished. | |descr= Plays in-game video with a range of options. The function can be [[call]]ed or [[spawn]]ed. If [[spawn]]ed, [[scriptDone]] command can be used to see if video is stopped or finished. If [[call]]ed in scheduled environment, the next line of code will not process until the video is stopped or finished.<br> | ||
The function also calls "BIS_fnc_playVideo_started" and "BIS_fnc_playVideo_stopped" Scripted Event Handlers in [[missionNamespace]] | The function also calls {{hl|"BIS_fnc_playVideo_started"}} and {{hl|"BIS_fnc_playVideo_stopped"}} Scripted Event Handlers in [[missionNamespace]] - see [[BIS_fnc_addScriptedEventHandler]] and [[Arma 3: Scripted Event Handlers]]. | ||
| | {{Feature|informative| | ||
* to play the video on an object, e.g an in-game screen, see {{Link|#Example 3}} | |||
* the video can be stopped in a variety of ways - see {{Link|#Example 4}} | |||
* see [[OGV File Format]] for format and conversion information. | |||
}} | |||
| | |s1= [content, size, color, skipVarName, bgColor, keepAspect] spawn [[BIS_fnc_playVideo]] | ||
| | |p1= content: [[String]] - full path to {{hl|.ogv}} file | ||
| | |p2= size: [[Array]] of [[Number]]s - (Optional, default [<nowiki/>[[safeZoneX]], [[safeZoneY]], [[safeZoneW]], [[safeZoneH]]]) screen size in format [x, y, w, h] | ||
{{Feature|informative|If the aspect ratio of the size parameter is not the same as the aspect ratio of the video file, black bars will be visibile. The video will not be stretched}} | |||
| | |p3= color: [[Array]] of [[Number]]s - (Optional, default [1,1,1,1]) foreground color in format [r, g, b, a] | ||
| | |p4= skipVarName: [[String]] - (Optional, default "BIS_fnc_playVideo_skipVideo") [[missionNamespace]] variable to skip the video when variable is [[true]] | ||
| | |p5= bgColor: [[Array]] format [[Color|Color (RGBA)]] - (Optional, default: [0,0,0,1]) background color in format [r, g, b, a] | ||
| [[Boolean]] - [[true]] | |p6= keepAspect: [[Boolean]] - (Optional, default [[true]]) [[true]] to keep original video aspect ratio (background color will fill the void), [[false]] to stretch | ||
| | |r1= [[Boolean]] - [[true]] | ||
| | |x1= <sqf>private _video = ["A3\Missions_F_EPA\video\A_in_intro.ogv"] spawn BIS_fnc_playVideo;</sqf> | ||
| | |x2= <sqf>private _video = ["\a3\missions_f_exp\video\exp_m04_v01.ogv"] call BIS_fnc_playVideo;</sqf> | ||
| [[ | |x3= <sqf> | ||
_video = "a3\missions_f_exp\video\exp_m07_vout.ogv"; | |||
_screen = "Land_TripodScreen_01_large_F" createVehicle (player modelToWorld [0,10,0]); | |||
_screen setObjectTexture [0, _video]; | |||
[_video, [10, 10]] call BIS_fnc_playVideo; | |||
</sqf> | |||
| | |x4= How to stop the video: | ||
* call or spawn the function with an empty string: <sqf>[""] call BIS_fnc_playVideo;</sqf> | |||
* call or spawn the function with another video: <sqf>["\a3\missions_f_exp\video\exp_m04_v02.ogv"] call BIS_fnc_playVideo;</sqf> | |||
* set the variable "BIS_fnc_playVideo_skipVideo" to [[true]]: <sqf>missionNamespace setVariable ["BIS_fnc_playVideo_skipVideo", true];</sqf> | |||
* set the custom skip variable (''skipVarName'') to [[true]]: <sqf> | |||
missionNamespace setVariable ["MyCustomSkipVar", true]; | |||
sleep 1; | |||
missionNamespace setVariable ["MyCustomSkipVar", nil]; // so it can be reused later | |||
</sqf> | |||
|seealso= [[Functions Library]] | |||
}} | }} | ||
{{Note | |||
|user= Dedmen | |||
|timestamp= 20191111183100 | |||
|text= Example ffmpeg command to encode a ogv video which can be played back. | |||
<sqf>ffmpeg -i input.mp4 -c:v libtheora -q:v 7 -c:a libvorbis -q:a 4 intro.ogv</sqf> | |||
See [[OGV File Format]]. | |||
}} | |||
Example ffmpeg command to encode a ogv video which can be played back. | |||
< | |||
Latest revision as of 10:28, 13 January 2024
Description
- Description:
- Plays in-game video with a range of options. The function can be called or spawned. If spawned, scriptDone command can be used to see if video is stopped or finished. If called in scheduled environment, the next line of code will not process until the video is stopped or finished.
The function also calls "BIS_fnc_playVideo_started" and "BIS_fnc_playVideo_stopped" Scripted Event Handlers in missionNamespace - see BIS_fnc_addScriptedEventHandler and Arma 3: Scripted Event Handlers. - Execution:
- call
- Groups:
- GUI
Syntax
- Syntax:
- [content, size, color, skipVarName, bgColor, keepAspect] spawn BIS_fnc_playVideo
- Parameters:
- content: String - full path to .ogv file
- size: Array of Numbers - (Optional, default [safeZoneX, safeZoneY, safeZoneW, safeZoneH]) screen size in format [x, y, w, h]
- color: Array of Numbers - (Optional, default [1,1,1,1]) foreground color in format [r, g, b, a]
- skipVarName: String - (Optional, default "BIS_fnc_playVideo_skipVideo") missionNamespace variable to skip the video when variable is true
- bgColor: Array format Color (RGBA) - (Optional, default: [0,0,0,1]) background color in format [r, g, b, a]
- keepAspect: Boolean - (Optional, default true) true to keep original video aspect ratio (background color will fill the void), false to stretch
- Return Value:
- Boolean - true
Examples
- Example 1:
- Example 2:
- Example 3:
- _video = "a3\missions_f_exp\video\exp_m07_vout.ogv"; _screen = "Land_TripodScreen_01_large_F" createVehicle (player modelToWorld [0,10,0]); _screen setObjectTexture [0, _video]; [_video, [10, 10]] call BIS_fnc_playVideo;
- Example 4:
- How to stop the video:
- call or spawn the function with an empty string:
- call or spawn the function with another video:
- set the variable "BIS_fnc_playVideo_skipVideo" to true:
- set the custom skip variable (skipVarName) to true: missionNamespace setVariable ["MyCustomSkipVar", true]; sleep 1; missionNamespace setVariable ["MyCustomSkipVar", nil]; // so it can be reused later
- call or spawn the function with an empty string:
Additional Information
- See also:
- Functions Library
Notes
-
Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
- Posted on Nov 11, 2019 - 18:31 (UTC)
- Example ffmpeg command to encode a ogv video which can be played back. See OGV File Format.