classdef VideoPlayer
%VideoPlayer Play video or display image
%   HVP = vision.VideoPlayer returns a video player System object, HVP, to
%   view video or image sequences in MATLAB on the screen.
%
%   HVP = vision.VideoPlayer('PropertyName', PropertyValue, ...) returns a
%   video player System object, HVP, with each specified property set to
%   the specified value.
%
%   Step method syntax:
%
%   step(HVP, I) sends one frame of a multidimensional video I to the video
%   player.
%
%   VideoPlayer methods:
%
%   step     - See above description for use of this method
%   release  - Allow property value and input characteristics changes, and
%              release video player resources
%   clone    - Create video player object with same property values
%   isLocked - Locked status (logical)
%   reset    - Clear scope figure
%   show     - Turn on visibility of scope figure
%   hide     - Turn off visibility of scope figure
%
%   VideoPlayer properties:
%
%   Name     - Caption to display on video player window
%   Position - Scope window position in pixels
%
%   % EXAMPLE:  Play back a video on the screen.
%      hmfr = vision.VideoFileReader;
%      hvp = vision.VideoPlayer;
%      while ~isDone(hmfr)
%        frame = step(hmfr);
%        step(hvp, frame);
%      end
%      release(hmfr);
%      release(hvp);
%
%   See also vision.DeployableVideoPlayer, vision.VideoFileWriter.

 
%   Copyright 2009-2010 The MathWorks, Inc.

    methods
        function out=VideoPlayer
            %VideoPlayer Play video or display image
            %   HVP = vision.VideoPlayer returns a video player System object, HVP, to
            %   view video or image sequences in MATLAB on the screen.
            %
            %   HVP = vision.VideoPlayer('PropertyName', PropertyValue, ...) returns a
            %   video player System object, HVP, with each specified property set to
            %   the specified value.
            %
            %   Step method syntax:
            %
            %   step(HVP, I) sends one frame of a multidimensional video I to the video
            %   player.
            %
            %   VideoPlayer methods:
            %
            %   step     - See above description for use of this method
            %   release  - Allow property value and input characteristics changes, and
            %              release video player resources
            %   clone    - Create video player object with same property values
            %   isLocked - Locked status (logical)
            %   reset    - Clear scope figure
            %   show     - Turn on visibility of scope figure
            %   hide     - Turn off visibility of scope figure
            %
            %   VideoPlayer properties:
            %
            %   Name     - Caption to display on video player window
            %   Position - Scope window position in pixels
            %
            %   % EXAMPLE:  Play back a video on the screen.
            %      hmfr = vision.VideoFileReader;
            %      hvp = vision.VideoPlayer;
            %      while ~isDone(hmfr)
            %        frame = step(hmfr);
            %        step(hvp, frame);
            %      end
            %      release(hmfr);
            %      release(hvp);
            %
            %   See also vision.DeployableVideoPlayer, vision.VideoFileWriter.
        end

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

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

    end
    methods (Abstract)
    end
    properties
        %Name Caption to display on video player window
        %   Specify the caption to display on the scope window as any string.
        %   The default value of this property is 'Video Player'. This property
        %   is tunable.
        Name;

    end
end
