Class: OpenCV::Cv::VideoWriter

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

.fourcc(_c1, _c2, _c3, _c4) ⇒ Fixnum

Note:

wrapper for static method int cv::VideoWriter::fourcc(char c1, char c2, char c3, char c4)

Parameters:

  • _c1 (Char)
  • _c2 (Char)
  • _c3 (Char)
  • _c4 (Char)

Returns:

  • (Fixnum) 


38514
38515
38516
 
# File 'lib/ropencv/ropencv_types.rb', line 38514

def self.fourcc(_c1, _c2, _c3, _c4)
    Rbind::cv_video_writer_fourcc(_c1, _c2, _c3, _c4)
end

.video_writer ⇒ Object .video_writer(filename, fourcc, fps, frame_size, is_color = true) ⇒ Object .video_writer(filename, api_preference, fourcc, fps, frame_size, is_color = true) ⇒ Object .video_writer(filename, fourcc, fps, frame_size, params) ⇒ Object .video_writer(filename, api_preference, fourcc, fps, frame_size, params) ⇒ Object

Overloads:

  • .video_writer(filename, fourcc, fps, frame_size, is_color = true) ⇒ Object

    Parameters:

    • filename (Std::String)
    • fourcc (Fixnum)
    • fps (Double)
    • frame_size (Cv::Size)
    • is_color (Bool) (defaults to: true)
  • .video_writer(filename, api_preference, fourcc, fps, frame_size, is_color = true) ⇒ Object

    Parameters:

    • filename (Std::String)
    • api_preference (Fixnum)
    • fourcc (Fixnum)
    • fps (Double)
    • frame_size (Cv::Size)
    • is_color (Bool) (defaults to: true)
  • .video_writer(filename, fourcc, fps, frame_size, params) ⇒ Object

    Parameters:

  • .video_writer(filename, api_preference, fourcc, fps, frame_size, params) ⇒ Object

    Parameters:

Raises:

  • (ArgumentError) 


38222
38223
38224
38225
38226
38227
38228
38229
38230
38231
38232
38233
38234
38235
38236
38237
38238
38239
38240
38241
38242
38243
38244
38245
38246
38247
38248
38249
38250
38251
38252
38253
38254
38255
38256
38257
38258
38259
38260
38261
38262
38263
38264
38265
38266
38267
38268
38269
38270
38271
38272
38273
38274
38275
38276
38277
38278
38279
38280
38281
38282
38283
38284
38285
38286
38287
38288
38289
38290
38291
38292
38293
38294
38295
38296
38297
38298
 
# File 'lib/ropencv/ropencv_types.rb', line 38222

def self.new(*args)
    if args.first.is_a?(FFI::Pointer) || args.first.is_a?(VideoWriterStruct)
        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::VideoWriter::VideoWriter()
    @@cv_video_writer_video_writer_defaults0 ||= []
    if(args.size >= 0 && args.size <= 0)
        targs = args.clone
        targs.size.upto(-1) do |i|
            targs[i] = @@cv_video_writer_video_writer_defaults0[i]
        end
        begin
                return Rbind::cv_video_writer_video_writer(*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for cv::VideoWriter::VideoWriter(const std::string filename, int fourcc, double fps, const cv::Size frameSize, bool isColor = true)
    @@cv_video_writer_video_writer__2_defaults1 ||= [nil, nil, nil, nil, true]
    if(args.size >= 4 && args.size <= 5)
        targs = args.clone
        targs.size.upto(4) do |i|
            targs[i] = @@cv_video_writer_video_writer__2_defaults1[i]
        end
        begin
                return Rbind::cv_video_writer_video_writer__2(*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for cv::VideoWriter::VideoWriter(const std::string filename, int apiPreference, int fourcc, double fps, const cv::Size frameSize, bool isColor = true)
    @@cv_video_writer_video_writer__3_defaults2 ||= [nil, nil, nil, nil, nil, true]
    if(args.size >= 5 && args.size <= 6)
        targs = args.clone
        targs.size.upto(5) do |i|
            targs[i] = @@cv_video_writer_video_writer__3_defaults2[i]
        end
        begin
                return Rbind::cv_video_writer_video_writer__3(*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for cv::VideoWriter::VideoWriter(const std::string filename, int fourcc, double fps, const cv::Size frameSize, const std::vector<int> params)
    @@cv_video_writer_video_writer__4_defaults3 ||= [nil, nil, nil, nil, nil]
    if(args.size >= 5 && args.size <= 5)
        targs = args.clone
        targs.size.upto(4) do |i|
            targs[i] = @@cv_video_writer_video_writer__4_defaults3[i]
        end
        begin
                return Rbind::cv_video_writer_video_writer__4(*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for cv::VideoWriter::VideoWriter(const std::string filename, int apiPreference, int fourcc, double fps, const cv::Size frameSize, const std::vector<int> params)
    @@cv_video_writer_video_writer__5_defaults4 ||= [nil, nil, nil, nil, nil, nil]
    if(args.size >= 6 && args.size <= 6)
        targs = args.clone
        targs.size.upto(5) do |i|
            targs[i] = @@cv_video_writer_video_writer__5_defaults4[i]
        end
        begin
                return Rbind::cv_video_writer_video_writer__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



38187
38188
38189
 
# File 'lib/ropencv/ropencv_types.rb', line 38187

def self.null
    new(VideoWriterStruct.new)
end

Instance Method Details

#get(prop_id) ⇒ Double

Note:

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

Parameters:

  • prop_id (Fixnum)

Returns:

  • (Double) 


38503
38504
38505
38506
 
# File 'lib/ropencv/ropencv_types.rb', line 38503

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

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

Note:

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

Returns:



38520
38521
38522
38523
38524
38525
38526
38527
38528
 
# File 'lib/ropencv/ropencv_types.rb', line 38520

def get_backend_name()
    __validate_pointer__
    result = Rbind::cv_video_writer_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

#is_opened ⇒ Bool Also known as: isOpened

Note:

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

Returns:

  • (Bool) 


38470
38471
38472
38473
 
# File 'lib/ropencv/ropencv_types.rb', line 38470

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

#open(filename, fourcc, fps, frame_size, is_color = true) ⇒ Bool #open(filename, api_preference, fourcc, fps, frame_size, is_color = true) ⇒ Bool #open(filename, fourcc, fps, frame_size, params) ⇒ Bool #open(filename, api_preference, fourcc, fps, frame_size, params) ⇒ Bool

Note:

wrapper for overloaded method open

methods

Overloads:

  • #open(filename, fourcc, fps, frame_size, is_color = true) ⇒ Bool

    Parameters:

    • filename (Std::String)
    • fourcc (Fixnum)
    • fps (Double)
    • frame_size (Cv::Size)
    • is_color (Bool) (defaults to: true)

    Returns:

    • (Bool)
  • #open(filename, api_preference, fourcc, fps, frame_size, is_color = true) ⇒ Bool

    Parameters:

    • filename (Std::String)
    • api_preference (Fixnum)
    • fourcc (Fixnum)
    • fps (Double)
    • frame_size (Cv::Size)
    • is_color (Bool) (defaults to: true)

    Returns:

    • (Bool)
  • #open(filename, fourcc, fps, frame_size, params) ⇒ Bool

    Parameters:

    Returns:

    • (Bool)
  • #open(filename, api_preference, fourcc, fps, frame_size, params) ⇒ Bool

    Parameters:

    Returns:

    • (Bool)

Raises:

  • (ArgumentError) 


38407
38408
38409
38410
38411
38412
38413
38414
38415
38416
38417
38418
38419
38420
38421
38422
38423
38424
38425
38426
38427
38428
38429
38430
38431
38432
38433
38434
38435
38436
38437
38438
38439
38440
38441
38442
38443
38444
38445
38446
38447
38448
38449
38450
38451
38452
38453
38454
38455
38456
38457
38458
38459
38460
38461
38462
38463
38464
38465
38466
 
# File 'lib/ropencv/ropencv_types.rb', line 38407

def open(*args)
    __validate_pointer__
    # overloaded method wrapper for bool cv::VideoWriter::open(const std::string filename, int fourcc, double fps, const cv::Size frameSize, bool isColor = true)
    @@cv_video_writer_open_defaults0 ||= [nil, nil, nil, nil, true]
    if(args.size >= 4 && args.size <= 5)
        targs = args.clone
        targs.size.upto(4) do |i|
            targs[i] = @@cv_video_writer_open_defaults0[i]
        end
        begin
                return Rbind::cv_video_writer_open(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for bool cv::VideoWriter::open(const std::string filename, int apiPreference, int fourcc, double fps, const cv::Size frameSize, bool isColor = true)
    @@cv_video_writer_open__2_defaults1 ||= [nil, nil, nil, nil, nil, true]
    if(args.size >= 5 && args.size <= 6)
        targs = args.clone
        targs.size.upto(5) do |i|
            targs[i] = @@cv_video_writer_open__2_defaults1[i]
        end
        begin
                return Rbind::cv_video_writer_open__2(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for bool cv::VideoWriter::open(const std::string filename, int fourcc, double fps, const cv::Size frameSize, const std::vector<int> params)
    @@cv_video_writer_open__3_defaults2 ||= [nil, nil, nil, nil, nil]
    if(args.size >= 5 && args.size <= 5)
        targs = args.clone
        targs.size.upto(4) do |i|
            targs[i] = @@cv_video_writer_open__3_defaults2[i]
        end
        begin
                return Rbind::cv_video_writer_open__3(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

    # overloaded method wrapper for bool cv::VideoWriter::open(const std::string filename, int apiPreference, int fourcc, double fps, const cv::Size frameSize, const std::vector<int> params)
    @@cv_video_writer_open__4_defaults3 ||= [nil, nil, nil, nil, nil, nil]
    if(args.size >= 6 && args.size <= 6)
        targs = args.clone
        targs.size.upto(5) do |i|
            targs[i] = @@cv_video_writer_open__4_defaults3[i]
        end
        begin
                return Rbind::cv_video_writer_open__4(self,*targs)
        rescue TypeError => e
            @error = e
        end
    end

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

#release ⇒ Void

Note:

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

Returns:

  • (Void) 


38478
38479
38480
38481
 
# File 'lib/ropencv/ropencv_types.rb', line 38478

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

#set(prop_id, value) ⇒ Bool

Note:

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

Parameters:

  • prop_id (Fixnum)
  • value (Double)

Returns:

  • (Bool) 


38495
38496
38497
38498
 
# File 'lib/ropencv/ropencv_types.rb', line 38495

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

#to_s ⇒ Object

converts VideoWriter into a string by crawling through all its attributes



38364
38365
38366
 
# File 'lib/ropencv/ropencv_types.rb', line 38364

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

#write(image) ⇒ Void

Note:

method wrapper for void cv::VideoWriter::write(const cv::Mat image)

Parameters:

Returns:

  • (Void) 


38486
38487
38488
38489
 
# File 'lib/ropencv/ropencv_types.rb', line 38486

def write(image)
    __validate_pointer__
    Rbind::cv_video_writer_write( self, image)
end