Module: GPhoto2::Camera::Capture

Included in:
GPhoto2::Camera
Defined in:
lib/gphoto2/camera/capture.rb

Instance Method Summary collapse

Instance Method Details

#capture(type = :image) ⇒ GPhoto2::CameraFile

Examples:

# Take a photo.
file = camera.capture

# And save it to the current working directory.
file.save

Parameters:

Returns:



13
14
15
16
17
 
# File 'lib/gphoto2/camera/capture.rb', line 13

def capture(type = :image)
  save
  path = _capture(type)
  CameraFile.new(self, path.folder, path.name)
end

#preview ⇒ GPhoto2::CameraFile

Captures a preview from the camera.

Previews are not stored on the camera but are returned as data in a GPhoto2::CameraFile.

Examples:

# Capturing a preview is like using `Camera#capture`.
file = camera.preview

# The resulting file will have neither a folder nor name.
file.preview?
# => true

# But it will contain image data from the camera.
file.data
# => "\xFF\xD8\xFF\xDB\x00\x84\x00\x06..."

Returns:



54
55
56
57
 
# File 'lib/gphoto2/camera/capture.rb', line 54

def preview
  save
  capture_preview
end

#trigger ⇒ void

This method returns an undefined value.

Triggers a capture and immedately returns.

A camera trigger is the first half of a #capture. Instead of returning a GPhoto2::CameraFile, a trigger immediately returns and the caller has to poll for events.

Examples:

camera.trigger
event = camera.wait_for(:file_added)
event.data # => CameraFile


31
32
33
34
 
# File 'lib/gphoto2/camera/capture.rb', line 31

def trigger
  save
  trigger_capture
end