classdef DeployableVideoPlayer
%DeployableVideoPlayer Display video
%   HDVP = vision.DeployableVideoPlayer returns a deployable video player
%   System object, HDVP, that sends live video data to a computer screen.
%
%   HDVP = vision.DeployableVideoPlayer('PropertyName', PropertyValue, ...)
%   returns a deployable video player System object, HDVP, with each
%   specified property set to the specified value.
%
%   HDVP = vision.DeployableVideoPlayer(FRAMERATE, 'PropertyName',
%   PropertyValue, ...) returns a deployable video player System object,
%   HDVP, with the FrameRate property set to FRAMERATE and other specified
%   properties set to the specified values.
%
%   Step method syntax:
%
%   step(HDVP, I) sends one frame of a multidimensional video to the
%   computer screen.
%
%   step(HDVP, Y, CB, CR) sends one frame of YCbCr 4:2:2 data in the color
%   components Y, CB, and CR, to the computer screen when the
%   InputColorFormat is set 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.
%
%   DeployableVideoPlayer methods:
%
%   step     - See above description for use of this method
%   release  - Allow property value and input characteristics changes, and
%              release deployable video player resources
%   clone    - Create deployable video player object with same property values
%   isLocked - Locked status (logical)
%
%   DeployableVideoPlayer properties:
%
%   Location         - Location of bottom left corner of video window
%   Name             - Video window caption
%   Size             - Size of video display window
%   CustomSize       - Custom size for video player window
%   FrameRate        - Frame rate of video data
%   InputColorFormat - Color format of the input signal
%
%   % EXAMPLE:  Play back a video on the screen.
%      hmfr = vision.VideoFileReader;
%      hdvp = vision.DeployableVideoPlayer;
%      while ~isDone(hmfr)
%        frame = step(hmfr);
%        step(hdvp, frame);
%      end
%      release(hmfr);
%      release(hdvp);
%
%   See also vision.VideoFileWriter.

 
%   Copyright 2008-2010 The MathWorks, Inc.

    methods
        function out=DeployableVideoPlayer
            %DeployableVideoPlayer Display video
            %   HDVP = vision.DeployableVideoPlayer returns a deployable video player
            %   System object, HDVP, that sends live video data to a computer screen.
            %
            %   HDVP = vision.DeployableVideoPlayer('PropertyName', PropertyValue, ...)
            %   returns a deployable video player System object, HDVP, with each
            %   specified property set to the specified value.
            %
            %   HDVP = vision.DeployableVideoPlayer(FRAMERATE, 'PropertyName',
            %   PropertyValue, ...) returns a deployable video player System object,
            %   HDVP, with the FrameRate property set to FRAMERATE and other specified
            %   properties set to the specified values.
            %
            %   Step method syntax:
            %
            %   step(HDVP, I) sends one frame of a multidimensional video to the
            %   computer screen.
            %
            %   step(HDVP, Y, CB, CR) sends one frame of YCbCr 4:2:2 data in the color
            %   components Y, CB, and CR, to the computer screen when the
            %   InputColorFormat is set 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.
            %
            %   DeployableVideoPlayer methods:
            %
            %   step     - See above description for use of this method
            %   release  - Allow property value and input characteristics changes, and
            %              release deployable video player resources
            %   clone    - Create deployable video player object with same property values
            %   isLocked - Locked status (logical)
            %
            %   DeployableVideoPlayer properties:
            %
            %   Location         - Location of bottom left corner of video window
            %   Name             - Video window caption
            %   Size             - Size of video display window
            %   CustomSize       - Custom size for video player window
            %   FrameRate        - Frame rate of video data
            %   InputColorFormat - Color format of the input signal
            %
            %   % EXAMPLE:  Play back a video on the screen.
            %      hmfr = vision.VideoFileReader;
            %      hdvp = vision.DeployableVideoPlayer;
            %      while ~isDone(hmfr)
            %        frame = step(hmfr);
            %        step(hdvp, frame);
            %      end
            %      release(hmfr);
            %      release(hdvp);
            %
            %   See also vision.VideoFileWriter.
        end

        function isInactivePropertyImpl(in) %#ok<MANU>
        end

        function saveObjectImpl(in) %#ok<MANU>
        end

    end
    methods (Abstract)
    end
    properties
        %CustomSize Custom size for video player window
        %   Specify the custom size of the video player window as 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'. The default value for
        %   this property is [300 410].
        CustomSize;

        %FrameRate Frame rate of video data
        %   Specify the rate of video data in frames per second as a positive
        %   integer-valued scalar. The default value of this property is 30.
        FrameRate;

        %InputColorFormat Color format of the input signal
        %   Specify the color format of input data as one of [{'RGB'} | 'YCbCr
        %   4:2:2']. The number of columns in the Cb and Cr components must be
        %   half the number of columns in Y. The default value of this property
        %   is 'RGB'.
        InputColorFormat;

        %Location Location of bottom left corner of video player
        %   Specify the location for the bottom left corner of the video player
        %   window as 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 value of this
        %   property is dependent on the screen resolution, and will result in
        %   a window positioned in the center of the screen.
        Location;

        %Name Video window caption
        %   Specify the caption to display on the video player window as any
        %   string. The default value of this property is 'Deployable Video
        %   Player'.
        Name;

        %Size Size of video player window
        %   Specify the video player window size as one of ['Full-screen'|
        %   {'True size (1:1)'} | 'Custom']. When this property is set to
        %   'Full-screen', use the Esc key to exit out of full-screen mode.
        Size;

    end
end
