hornetseye-dc1394 0.3.4 → 0.3.5
Sign up to get free protection for your applications and to get access to all the features.
- data/Rakefile +1 -1
- data/lib/hornetseye-dc1394/docs.rb +284 -44
- metadata +2 -2
data/Rakefile
CHANGED
@@ -26,72 +26,312 @@ module Hornetseye
|
|
26
26
|
|
27
27
|
class << self
|
28
28
|
|
29
|
-
#
|
29
|
+
# Firewire bus speed
|
30
|
+
SPEED_100 = nil
|
31
|
+
|
32
|
+
# Firewire bus speed
|
33
|
+
SPEED_200 = nil
|
34
|
+
|
35
|
+
# Firewire bus speed
|
36
|
+
SPEED_400 = nil
|
37
|
+
|
38
|
+
# Firewire bus speed
|
39
|
+
SPEED_800 = nil
|
40
|
+
|
41
|
+
# Firewire bus speed
|
42
|
+
SPEED_1600 = nil
|
43
|
+
|
44
|
+
# Firewire bus speed
|
45
|
+
SPEED_3200 = nil
|
46
|
+
|
47
|
+
# Video mode
|
48
|
+
#
|
49
|
+
# @private
|
50
|
+
MODE_MONO8 = nil
|
51
|
+
|
52
|
+
# Video mode
|
53
|
+
#
|
54
|
+
# @private
|
55
|
+
MODE_YUV411 = nil
|
56
|
+
|
57
|
+
# Video mode
|
30
58
|
#
|
31
|
-
# @
|
32
|
-
|
33
|
-
end
|
59
|
+
# @private
|
60
|
+
MODE_YUV422 = nil
|
34
61
|
|
35
|
-
#
|
62
|
+
# Video mode
|
36
63
|
#
|
37
|
-
# @
|
38
|
-
|
39
|
-
end
|
64
|
+
# @private
|
65
|
+
MODE_YUV444 = nil
|
40
66
|
|
41
|
-
#
|
67
|
+
# Video mode
|
42
68
|
#
|
43
|
-
# @
|
44
|
-
|
45
|
-
end
|
69
|
+
# @private
|
70
|
+
MODE_RGB8 = nil
|
46
71
|
|
47
|
-
#
|
72
|
+
# Video mode
|
48
73
|
#
|
49
|
-
# @
|
50
|
-
|
51
|
-
end
|
74
|
+
# @private
|
75
|
+
MODE_MONO16 = nil
|
52
76
|
|
53
|
-
#
|
77
|
+
# Video mode
|
54
78
|
#
|
55
|
-
# @
|
56
|
-
|
57
|
-
|
79
|
+
# @private
|
80
|
+
MODE_RGB16 = nil
|
81
|
+
|
82
|
+
# Video mode
|
83
|
+
#
|
84
|
+
# @private
|
85
|
+
MODE_MONO16S = nil
|
86
|
+
|
87
|
+
# Video mode
|
88
|
+
#
|
89
|
+
# @private
|
90
|
+
MODE_RGB16S = nil
|
91
|
+
|
92
|
+
# Video mode
|
93
|
+
#
|
94
|
+
# @private
|
95
|
+
MODE_RAW8 = nil
|
96
|
+
|
97
|
+
# Video mode
|
98
|
+
#
|
99
|
+
# @private
|
100
|
+
MODE_RAW16 = nil
|
101
|
+
|
102
|
+
# Frame rate
|
103
|
+
FRAMERATE_1_875 = nil
|
104
|
+
|
105
|
+
# Frame rate
|
106
|
+
FRAMERATE_3_75 = nil
|
107
|
+
|
108
|
+
# Frame rate
|
109
|
+
FRAMERATE_7_5 = nil
|
110
|
+
|
111
|
+
# Frame rate
|
112
|
+
FRAMERATE_15 = nil
|
113
|
+
|
114
|
+
# Frame rate
|
115
|
+
FRAMERATE_30 = nil
|
116
|
+
|
117
|
+
# Frame rate
|
118
|
+
FRAMERATE_60 = nil
|
119
|
+
|
120
|
+
# Frame rate
|
121
|
+
FRAMERATE_120 = nil
|
122
|
+
|
123
|
+
# Frame rate
|
124
|
+
FRAMERATE_240 = nil
|
125
|
+
|
126
|
+
# First feature
|
127
|
+
FEATURE_MIN = nil
|
128
|
+
|
129
|
+
# A feature
|
130
|
+
FEATURE_BRIGHTNESS = nil
|
131
|
+
|
132
|
+
# A feature
|
133
|
+
FEATURE_EXPOSURE = nil
|
134
|
+
|
135
|
+
# A feature
|
136
|
+
FEATURE_SHARPNESS = nil
|
137
|
+
|
138
|
+
# A feature
|
139
|
+
FEATURE_WHITE_BALANCE = nil
|
140
|
+
|
141
|
+
# A feature
|
142
|
+
FEATURE_HUE = nil
|
143
|
+
|
144
|
+
# A feature
|
145
|
+
FEATURE_SATURATION = nil
|
146
|
+
|
147
|
+
# A feature
|
148
|
+
FEATURE_GAMMA = nil
|
149
|
+
|
150
|
+
# A feature
|
151
|
+
FEATURE_SHUTTER = nil
|
152
|
+
|
153
|
+
# A feature
|
154
|
+
FEATURE_GAIN = nil
|
155
|
+
|
156
|
+
# A feature
|
157
|
+
FEATURE_IRIS = nil
|
158
|
+
|
159
|
+
# A feature
|
160
|
+
FEATURE_FOCUS = nil
|
58
161
|
|
59
|
-
|
60
|
-
|
162
|
+
# A feature
|
163
|
+
FEATURE_TEMPERATURE = nil
|
61
164
|
|
62
|
-
|
63
|
-
|
165
|
+
# A feature
|
166
|
+
FEATURE_TRIGGER = nil
|
64
167
|
|
65
|
-
|
66
|
-
|
168
|
+
# A feature
|
169
|
+
FEATURE_TRIGGER_DELAY = nil
|
67
170
|
|
68
|
-
|
69
|
-
|
171
|
+
# A feature
|
172
|
+
FEATURE_WHITE_SHADING = nil
|
70
173
|
|
71
|
-
|
72
|
-
|
174
|
+
# A feature
|
175
|
+
FEATURE_FRAME_RATE = nil
|
73
176
|
|
74
|
-
|
75
|
-
|
177
|
+
# A feature
|
178
|
+
FEATURE_ZOOM = nil
|
76
179
|
|
77
|
-
|
78
|
-
|
180
|
+
# A feature
|
181
|
+
FEATURE_PAN = nil
|
79
182
|
|
80
|
-
|
81
|
-
|
183
|
+
# A feature
|
184
|
+
FEATURE_TILT = nil
|
82
185
|
|
83
|
-
|
84
|
-
|
186
|
+
# A feature
|
187
|
+
FEATURE_OPTICAL_FILTER = nil
|
85
188
|
|
86
|
-
|
87
|
-
|
189
|
+
# A feature
|
190
|
+
FEATURE_CAPTURE_SIZE = nil
|
88
191
|
|
89
|
-
|
90
|
-
|
192
|
+
# A feature
|
193
|
+
FEATURE_CAPTURE_QUALITY = nil
|
91
194
|
|
92
|
-
|
93
|
-
|
195
|
+
# Last feature
|
196
|
+
FEATURE_MAX = nil
|
197
|
+
|
198
|
+
# Feature mode
|
199
|
+
FEATURE_MODE_MANUAL = nil
|
200
|
+
|
201
|
+
# Feature mode
|
202
|
+
FEATURE_MODE_AUTO = nil
|
203
|
+
|
204
|
+
# Feature mode
|
205
|
+
FEATURE_MODE_ONE_PUSH_AUTO = nil
|
206
|
+
|
207
|
+
end
|
208
|
+
|
209
|
+
# Close the video device
|
210
|
+
#
|
211
|
+
# @return [DC1394Input] Returns +self+.
|
212
|
+
def close
|
213
|
+
end
|
214
|
+
|
215
|
+
# Read a video frame
|
216
|
+
#
|
217
|
+
# @return [MultiArray,Frame_] The video frame.
|
218
|
+
def read
|
219
|
+
end
|
220
|
+
|
221
|
+
# Check whether device is not closed
|
222
|
+
#
|
223
|
+
# @return [Boolean] Returns +true+ as long as device is open.
|
224
|
+
def status?
|
225
|
+
end
|
226
|
+
|
227
|
+
# Width of video input
|
228
|
+
#
|
229
|
+
# @return [Integer] Width of video frames.
|
230
|
+
def width
|
231
|
+
end
|
232
|
+
|
233
|
+
# Height of video input
|
234
|
+
#
|
235
|
+
# @return [Integer] Width of video frames.
|
236
|
+
def height
|
237
|
+
end
|
238
|
+
|
239
|
+
# Get value of feature
|
240
|
+
#
|
241
|
+
# @param [Integer] id Feature identifier.
|
242
|
+
#
|
243
|
+
# @return [Integer] Current value of feature.
|
244
|
+
def feature_read( id )
|
245
|
+
end
|
246
|
+
|
247
|
+
# Set value of feature
|
248
|
+
#
|
249
|
+
# @param [Integer] id Feature identifier.
|
250
|
+
#
|
251
|
+
# @return [Integer] Returns +value+.
|
252
|
+
def feature_write( id, value )
|
253
|
+
end
|
254
|
+
|
255
|
+
# Check for existence of feature
|
256
|
+
#
|
257
|
+
# @param [Integer] id Feature identifier.
|
258
|
+
#
|
259
|
+
# @return [Boolean] Returns +true+ if this feature is supported.
|
260
|
+
def feature_exist?( id )
|
261
|
+
end
|
262
|
+
|
263
|
+
# Check whether feature can be read
|
264
|
+
#
|
265
|
+
# @param [Integer] id Feature identifier.
|
266
|
+
#
|
267
|
+
# @return [Boolean] Returns +true+ if this feature can be read.
|
268
|
+
def feature_readable?( id )
|
269
|
+
end
|
270
|
+
|
271
|
+
# Check whether feature can be switched on and off
|
272
|
+
#
|
273
|
+
# @param [Integer] id Feature identifier.
|
274
|
+
#
|
275
|
+
# @return [Boolean] Returns +true+ if this feature can be switched on and off.
|
276
|
+
def feature_switchable?( id )
|
277
|
+
end
|
278
|
+
|
279
|
+
# Check whether feature is switched on
|
280
|
+
#
|
281
|
+
# @param [Integer] id Feature identifier.
|
282
|
+
#
|
283
|
+
# @return [Boolean] Returns +true+ if this feature is switched on.
|
284
|
+
def feature_on?( id )
|
285
|
+
end
|
286
|
+
|
287
|
+
# Switch feature on or off
|
288
|
+
#
|
289
|
+
# @param [Integer] id Feature identifier.
|
290
|
+
# @param [Boolean] value +true+ for on and +false+ for off.
|
291
|
+
#
|
292
|
+
# @return [Boolean] Returns +value+.
|
293
|
+
def feature_on( id, value )
|
294
|
+
end
|
295
|
+
|
296
|
+
# Get supported modes of feature
|
297
|
+
#
|
298
|
+
# @param [Integer] id Feature identifier.
|
299
|
+
#
|
300
|
+
# @return [Array<Integer>] Returns array with supported modes.
|
301
|
+
def feature_modes( id )
|
302
|
+
end
|
303
|
+
|
304
|
+
# Get current mode of feature
|
305
|
+
#
|
306
|
+
# @param [Integer] id Feature identifier.
|
307
|
+
#
|
308
|
+
# @return [Integer] Returns the current mode.
|
309
|
+
def feature_mode_read( id )
|
310
|
+
end
|
311
|
+
|
312
|
+
# Set mode of feature
|
313
|
+
#
|
314
|
+
# @param [Integer] id Feature identifier.
|
315
|
+
# @param [Integer] mode Mode of feature.
|
316
|
+
#
|
317
|
+
# @return [Integer] Returns +mode+.
|
318
|
+
def feature_mode_write( id, mode )
|
319
|
+
end
|
320
|
+
|
321
|
+
# Get minimum value of feature
|
322
|
+
#
|
323
|
+
# @param [Integer] id Feature identifier.
|
324
|
+
#
|
325
|
+
# @return [Integer] Minimum value of feature.
|
326
|
+
def feature_min( id )
|
327
|
+
end
|
94
328
|
|
329
|
+
# Get maximum value of feature
|
330
|
+
#
|
331
|
+
# @param [Integer] id Feature identifier.
|
332
|
+
#
|
333
|
+
# @return [Integer] Maximum value of feature.
|
334
|
+
def feature_max( id )
|
95
335
|
end
|
96
336
|
|
97
337
|
end
|