Class: OpenCV::Cv::VideoCapture

Inherits:
Object
  • Object
show all
Extended by:
FFI::DataConverter
Defined in:
lib/ropencv/ropencv_types.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.video_capture ⇒ Object .video_capture(filename, api_preference = CAP_ANY) ⇒ Object .video_capture(filename, api_preference, params) ⇒ Object .video_capture(index, api_preference = CAP_ANY) ⇒ Object .video_capture(index, api_preference, params) ⇒ Object

Overloads:

  • .video_capture(filename, api_preference = CAP_ANY) ⇒ Object

    Parameters:

    • filename (Std::String)
    • api_preference (Fixnum) (defaults to: CAP_ANY)
  • .video_capture(filename, api_preference, params) ⇒ Object

    Parameters:

  • .video_capture(index, api_preference = CAP_ANY) ⇒ Object

    Parameters:

    • index (Fixnum)
    • api_preference (Fixnum) (defaults to: CAP_ANY)
  • .video_capture(index, api_preference, params) ⇒ Object

    Parameters:

Raises:

  • (ArgumentError) 


37825
37826
37827
37828
37829
37830
37831
37832
37833
37834
37835
37836
37837
37838
37839
37840
37841
37842
37843
37844
37845
37846
37847
37848
37849
37850
37851
37852
37853
37854
37855
37856
37857
37858
37859
37860
37861
37862
37863
37864
37865
37866
37867
37868
37869
37870
37871
37872
37873
37874
37875
37876
37877
37878
37879
37880
37881
37882
37883
37884
37885
37886
37887
37888
37889
37890
37891
37892
37893
37894
37895
37896
37897
37898
37899
37900
37901
 
# File 'lib/ropencv/ropencv_types.rb', line 37825

def self.new(*args)
    if args.first.is_a?(FFI::Pointer) || args.first.is_a?(VideoCaptureStruct)
        raise ArgumentError, "too many arguments for creating #{self.name} from Pointer" unless args.size == 1
        return super(args.first)
    end
    # overloaded method wrapper for cv::VideoCapture::VideoCapture()
    @@cv_video_capture_video_capture_defaults0 ||= []
    if(args.size >= 0 && args.size <= 0)
        targs = args.clone
        targs.size.upto(-1) do |i|
            targs[i] = @@cv_video_capture_video_capture_defaults0[i]
        end
        begin
                return Rbind::cv_video_capture_video_capture(*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for cv::VideoCapture::VideoCapture(const std::string filename, int apiPreference = CAP_ANY)
    @@cv_video_capture_video_capture__2_defaults1 ||= [nil, CAP_ANY]
    if(args.size >= 1 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_video_capture_video_capture__2_defaults1[i]
        end
        begin
                return Rbind::cv_video_capture_video_capture__2(*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for cv::VideoCapture::VideoCapture(const std::string filename, int apiPreference, const std::vector<int> params)
    @@cv_video_capture_video_capture__3_defaults2 ||= [nil, nil, nil]
    if(args.size >= 3 && args.size <= 3)
        targs = args.clone
        targs.size.upto(2) do |i|
            targs[i] = @@cv_video_capture_video_capture__3_defaults2[i]
        end
        begin
                return Rbind::cv_video_capture_video_capture__3(*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for cv::VideoCapture::VideoCapture(int index, int apiPreference = CAP_ANY)
    @@cv_video_capture_video_capture__4_defaults3 ||= [nil, CAP_ANY]
    if(args.size >= 1 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_video_capture_video_capture__4_defaults3[i]
        end
        begin
                return Rbind::cv_video_capture_video_capture__4(*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for cv::VideoCapture::VideoCapture(int index, int apiPreference, const std::vector<int> params)
    @@cv_video_capture_video_capture__5_defaults4 ||= [nil, nil, nil]
    if(args.size >= 3 && args.size <= 3)
        targs = args.clone
        targs.size.upto(2) do |i|
            targs[i] = @@cv_video_capture_video_capture__5_defaults4[i]
        end
        begin
                return Rbind::cv_video_capture_video_capture__5(*targs)
        rescue TypeError => e
            @error = e
        end
    end

    raise ArgumentError, "no constructor for #{self}(#{args.inspect})"
end

.null ⇒ Object

returns a null pointer to the object



37802
37803
37804
 
# File 'lib/ropencv/ropencv_types.rb', line 37802

def self.null
    new(VideoCaptureStruct.new)
end

Instance Method Details

#get(prop_id) ⇒ Double

Note:

method wrapper for double cv::VideoCapture::get(int propId)

Parameters:

  • prop_id (Fixnum)

Returns:

  • (Double) 


38110
38111
38112
38113
 
# File 'lib/ropencv/ropencv_types.rb', line 38110

def get(prop_id)
    __validate_pointer__
    Rbind::cv_video_capture_get( self, prop_id)
end

#get_backend_name ⇒ Std::String Also known as: getBackendName

Note:

method wrapper for const std::string cv::VideoCapture::getBackendName()

Returns:



38117
38118
38119
38120
38121
38122
38123
38124
38125
 
# File 'lib/ropencv/ropencv_types.rb', line 38117

def get_backend_name()
    __validate_pointer__
    result = Rbind::cv_video_capture_get_backend_name( self)
    if result.respond_to?(:__owner__?) && !result.__owner__?
    # store owner insight the pointer to not get garbage collected
        result.instance_variable_get(:@__obj_ptr__).instance_variable_set(:@__owner__,self) 
    end
    result
end

#get_exception_mode ⇒ Bool Also known as: getExceptionMode

Note:

method wrapper for bool cv::VideoCapture::getExceptionMode()

Returns:

  • (Bool) 


38139
38140
38141
38142
 
# File 'lib/ropencv/ropencv_types.rb', line 38139

def get_exception_mode()
    __validate_pointer__
    Rbind::cv_video_capture_get_exception_mode( self)
end

#grab ⇒ Bool

Note:

method wrapper for bool cv::VideoCapture::grab()

Returns:

  • (Bool) 


38076
38077
38078
38079
 
# File 'lib/ropencv/ropencv_types.rb', line 38076

def grab()
    __validate_pointer__
    Rbind::cv_video_capture_grab( self)
end

#is_opened ⇒ Bool Also known as: isOpened

Note:

method wrapper for bool cv::VideoCapture::isOpened()

Returns:

  • (Bool) 


38061
38062
38063
38064
 
# File 'lib/ropencv/ropencv_types.rb', line 38061

def is_opened()
    __validate_pointer__
    Rbind::cv_video_capture_is_opened( self)
end

#open(filename, api_preference = CAP_ANY) ⇒ Bool #open(filename, api_preference, params) ⇒ Bool #open(index, api_preference = CAP_ANY) ⇒ Bool #open(index, api_preference, params) ⇒ Bool

Note:

wrapper for overloaded method open

methods

Overloads:

  • #open(filename, api_preference = CAP_ANY) ⇒ Bool

    Parameters:

    • filename (Std::String)
    • api_preference (Fixnum) (defaults to: CAP_ANY)

    Returns:

    • (Bool)
  • #open(filename, api_preference, params) ⇒ Bool

    Parameters:

    Returns:

    • (Bool)
  • #open(index, api_preference = CAP_ANY) ⇒ Bool

    Parameters:

    • index (Fixnum)
    • api_preference (Fixnum) (defaults to: CAP_ANY)

    Returns:

    • (Bool)
  • #open(index, api_preference, params) ⇒ Bool

    Parameters:

    Returns:

    • (Bool)

Raises:

  • (ArgumentError) 


37998
37999
38000
38001
38002
38003
38004
38005
38006
38007
38008
38009
38010
38011
38012
38013
38014
38015
38016
38017
38018
38019
38020
38021
38022
38023
38024
38025
38026
38027
38028
38029
38030
38031
38032
38033
38034
38035
38036
38037
38038
38039
38040
38041
38042
38043
38044
38045
38046
38047
38048
38049
38050
38051
38052
38053
38054
38055
38056
38057
 
# File 'lib/ropencv/ropencv_types.rb', line 37998

def open(*args)
    __validate_pointer__
    # overloaded method wrapper for bool cv::VideoCapture::open(const std::string filename, int apiPreference = CAP_ANY)
    @@cv_video_capture_open_defaults0 ||= [nil, CAP_ANY]
    if(args.size >= 1 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_video_capture_open_defaults0[i]
        end
        begin
                return Rbind::cv_video_capture_open(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for bool cv::VideoCapture::open(const std::string filename, int apiPreference, const std::vector<int> params)
    @@cv_video_capture_open__2_defaults1 ||= [nil, nil, nil]
    if(args.size >= 3 && args.size <= 3)
        targs = args.clone
        targs.size.upto(2) do |i|
            targs[i] = @@cv_video_capture_open__2_defaults1[i]
        end
        begin
                return Rbind::cv_video_capture_open__2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for bool cv::VideoCapture::open(int index, int apiPreference = CAP_ANY)
    @@cv_video_capture_open__3_defaults2 ||= [nil, CAP_ANY]
    if(args.size >= 1 && args.size <= 2)
        targs = args.clone
        targs.size.upto(1) do |i|
            targs[i] = @@cv_video_capture_open__3_defaults2[i]
        end
        begin
                return Rbind::cv_video_capture_open__3(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for bool cv::VideoCapture::open(int index, int apiPreference, const std::vector<int> params)
    @@cv_video_capture_open__4_defaults3 ||= [nil, nil, nil]
    if(args.size >= 3 && args.size <= 3)
        targs = args.clone
        targs.size.upto(2) do |i|
            targs[i] = @@cv_video_capture_open__4_defaults3[i]
        end
        begin
                return Rbind::cv_video_capture_open__4(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    raise ArgumentError, "No overloaded signature fits to: #{args.map(&:class)}"
end

#read(image) ⇒ Bool

Note:

method wrapper for bool cv::VideoCapture::read(cv::Mat& image)

Parameters:

Returns:

  • (Bool) 


38093
38094
38095
38096
 
# File 'lib/ropencv/ropencv_types.rb', line 38093

def read(image)
    __validate_pointer__
    Rbind::cv_video_capture_read( self, image)
end

#release ⇒ Void

Note:

method wrapper for void cv::VideoCapture::release()

Returns:

  • (Void) 


38069
38070
38071
38072
 
# File 'lib/ropencv/ropencv_types.rb', line 38069

def release()
    __validate_pointer__
    Rbind::cv_video_capture_release( self)
end

#retrieve(image, flag = 0) ⇒ Bool

Note:

method wrapper for bool cv::VideoCapture::retrieve(cv::Mat& image, int flag = 0)

Parameters:

  • image (Cv::Mat)
  • flag (Fixnum) (defaults to: 0)

Returns:

  • (Bool) 


38085
38086
38087
38088
 
# File 'lib/ropencv/ropencv_types.rb', line 38085

def retrieve(image, flag = 0)
    __validate_pointer__
    Rbind::cv_video_capture_retrieve( self, image, flag)
end

#set(prop_id, value) ⇒ Bool

Note:

method wrapper for bool cv::VideoCapture::set(int propId, double value)

Parameters:

  • prop_id (Fixnum)
  • value (Double)

Returns:

  • (Bool) 


38102
38103
38104
38105
 
# File 'lib/ropencv/ropencv_types.rb', line 38102

def set(prop_id, value)
    __validate_pointer__
    Rbind::cv_video_capture_set( self, prop_id, value)
end

#set_exception_mode(enable) ⇒ Void Also known as: setExceptionMode

Note:

method wrapper for void cv::VideoCapture::setExceptionMode(bool enable)

Parameters:

  • enable (Bool)

Returns:

  • (Void) 


38131
38132
38133
38134
 
# File 'lib/ropencv/ropencv_types.rb', line 38131

def set_exception_mode(enable)
    __validate_pointer__
    Rbind::cv_video_capture_set_exception_mode( self, enable)
end

#to_s ⇒ Object

converts VideoCapture into a string by crawling through all its attributes



37967
37968
37969
 
# File 'lib/ropencv/ropencv_types.rb', line 37967

def to_s
    "#<cv::VideoCapture >"
end