Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

vision.DeployableVideoPlayer System object

Display video

Description

The DeployableVideoPlayer object displays video frames. This player is capable of displaying high definition video at high frame rates. This video player object supports C code generation.

Note

Starting in R2016b, instead of using the step method to perform the operation defined by the System object™, you can call the object with arguments, as if it were a function. For example, y = step(obj,x) and y = obj(x) perform equivalent operations.

Construction

depVideoPlayer = vision.DeployableVideoPlayer returns a video player System object, depVideoPlayer, for displaying video frames. Each call to the step method, displays the next video frame. This object, unlike the vision.VideoPlayer object, can generate C code.

depVideoPlayer = vision.DeployableVideoPlayer(___,Name,Value) configures the video player properties, specified as one or more Name,Value pair arguments. Unspecified properties have default values.

To display video:

  1. Define and set up your deployable video player object using the constructor.

  2. Call the step method with the deployable video player object, depVideoPlayer, and any optional properties. See the syntax below for using the step method.

step(depVideoPlayer,I) displays one grayscale or truecolor RGB video frame, I, in the video player.

step(depVideoPlayer,Y,Cb,Cr) displays one frame of YCbCr 4:2:2 video in the color components Y, Cb, and Cr when you set the InputColorFormat property to YCbCr 4:2:2. The number of columns in the Cb and Cr components must be half the number of columns in the Y component.

Properties

expand all

Location of bottom left corner of video window, specified as the comma-separated pair consisting of 'Location' and a two-element vector. The first and second elements are specified in pixels and represent the horizontal and vertical coordinates respectively. The coordinates [0 0] represent the bottom left corner of the screen. The default location depends on the screen resolution, and will result in a window positioned in the center of the screen.

Video window title bar caption, specified as the comma-separated pair consisting of 'Name' and a character vector.

Size of video display window, specified as the comma-separated pair consisting of 'Size' and Full-screen, True size (1:1) or Custom. When this property is set to Full-screen, use the Esc key to exit out of full-screen mode.

Custom size for video player window, specified as the comma-separated pair consisting of 'CustomSize' and a two-element vector. The first and second elements are specified in pixels and represent the horizontal and vertical components respectively. The video data will be resized to fit the window. This property applies when you set the Size property to Custom.

Color format of input signal, specified as the comma-separated pair consisting of 'InputColorFormat' and 'RGB' or 'YCbCr 4:2:2'. The number of columns in the Cb and Cr components must be half the number of columns in Y.

Methods

isOpenVisible or hidden status for video player figure
stepSend multidimensional video to computer screen
Common to All System Objects
clone

Create System object with same property values

getNumInputs

Expected number of inputs to a System object

getNumOutputs

Expected number of outputs of a System object

isLocked

Check locked states of a System object (logical)

release

Allow System object property value changes

Examples

expand all

Set up System objects to read and view a video file.

videoFReader   = vision.VideoFileReader('atrium.mp4');
depVideoPlayer = vision.DeployableVideoPlayer;

Continue to read frames of video until the last frame is read. Exit the loop if user closes the video player window.

cont = ~isDone(videoFReader);
  while cont
    frame = step(videoFReader);
    step(depVideoPlayer, frame);   
    cont = ~isDone(videoFReader) && isOpen(depVideoPlayer);
  end

Release System objects.

release(videoFReader);
release(depVideoPlayer);

Extended Capabilities

Introduced in R2012a