VisionWorks Toolkit Reference

September 29, 2015 | 1.0 Release

 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
stable/player/player_user_guide.md
Go to the documentation of this file.
1 <!-- Copyright (c) 2014-2015, NVIDIA CORPORATION. All rights reserved. -->
2 
3 @defgroup vwx_sample_player Video Playback Sample App
4 @brief Video Playback Sample user guide.
5 @ingroup nvx_samples
6 @{
7 
8 <a name="Introduction">
9 ## Introduction ##
10 
11 `nvx_sample_player` demonstrates basic image and video I/O facilities and camera access.
12 
13 `nvx_sample_player` is installed in the following directory:
14 
15  /usr/share/visionworks/sources/samples/player
16 
17 For the steps to build sample applications, see the @ref nvx_samples_and_demos section for your OS.
18 
19 <a name="Executing">
20 ## Executing the Player Sample ##
21 
22  ./nvx_sample_player [options]
23 
24 ### Command Line Options ###
25 
26 This topic provides a list of supported options and the values they consume.
27 
28 #### \-s, \--source ####
29 - Parameter: [inputUri]
30 - Description: Specifies the input URI. Accepted parameters include a video (in .avi format), an image or an image sequence (.png, .jpg, .jpeg, .bmp, .tiff), camera to grab frames.
31 - Usage:
32 
33  - `--source=/path/to/video.avi` for video
34  - `--source=/path/to/image.png` for image
35  - `--source=/path/to/image_%04d_sequence.png` for image sequence
36  - `--source=device://camera0` for the first camera
37  - `--source=device://camera1` for the second camera.
38 
39 @note On Vibrante V3Le, V4L platforms hardware accelerated video playback is supported for H.264
40 elementary streams only.
41 
42 @note The V4L platform has a permissions issue. If input data are an H.264 elementary stream, hardware decoder
43 is used and sample must be executed with super user permissions, i.e., with `sudo`.
44 
45 #### \-h, \--help ####
46 - Description: Prints the help message.
47 
48 ### Operational Keys ###
49 - Use `Space` to pause/resume the sample.
50 - Use `ESC` to close the sample.
51 
52 @}