アールテクニカ地下ガレージ

アールテクニカ株式会社の製品開発・研究開発・日々の活動です

Resolume OSC Address List


Author

Tobetchi

I made a list of OSC(OpenSound Control) addresses that available on Resolume.

Items

Address
OSC address.
OSC Type
The type of the OSC argument.
Int: int32, Float: float32, String: OSC-string
OSC Range
The range of the OSC value.
Range
The range of value being mapped to the OSC argument.
Description
The description of the OSC address.
Type
The type of OSC Object in Resolume.
  • E: Event - Used for functions such as Clear layer that are represented in the interface by a one-click button. Pass it Int 1.
  • T: Toggle - Used for functions such as Bypass layer that are represented by a toggle button. Pass it Int 0 or 1.
  • S: String - Used to pass in text, can be used to set the name of a clip.
  • P: Parameter - Used for functions such as Layer Opacity that are represented by a slider with options to animate and control it in various ways.

Target Version

  • Resolume Arena 5
  • Resolume Avenue 4

About Resolume OSC Pattern

In resolume osc pattern, you can take only one arguments.
A multiple parameters, layer number, clip number, etc, included in address path.

Example:

/layer1/clear 1 #Clear from the 1st layer.
/layer2/clear 1 #Clear from the 2nd layer.

Primary Sources

Composition

Address OSC Type OSC Range Range Description Type
/composition/disconnectall Int 0 or 1 Stop the playing clips from all layers. E
/composition/bypassed Int 0 or 1 Make all the videos in the layers invisible. T
/composition/select Int 0 or 1 Previews the composition in the preview window. T
/composition/opacityandvolume Float 0.0 - 1.0 Fade the entire composition in or out. P
/composition/speed Float 0.0 - 1.0 0.0 - 10.0 Control the speed of all clips currently playing. P
/composition/cross/values Float 0.0 - 1.0 -1.0 - 1.0 A/B with crossfader. P
/composition/fadetogroupa Int 0 or 1 Fade to bus A. E
/composition/fadetogroupb Int 0 or 1 Fade to bus A. E
/composition/recording/recording Int 0 or 1 Recording start or stop. T
/composition/direction Int 0 to 3 Set the direction all clip plays.
0: Backward
1: Forward
2: Pause
3: Random
P

Dashboard

Address OSC Type OSC Range Range Description Type
/composition/link1/values Float 0.0 - 1.0 A value of dial on the dashboard.
number of link: 1-8
P

Audio

Address OSC Type OSC Range Range Description Type
/composition/audio/volume/values Float 0.0 - 1.0 -40.0 - 12.0 A volume. P
/composition/audio/pan/values Float 0.0 - 1.0 -1.0 - 1.0 A direction to pan. P

Transform

Address OSC Type OSC Range Range Description Type
/composition/video/fadeout/values Float 0.0 - 1.0 Fade in/out the entire composition's video. P
/composition/video/scale/values Float 0.0 - 1.0 0.0 - 1000.0 Scale the output video. P
/composition/video/rotatex/values Float 0.0 - 1.0 -180.0 - 180.0 A rotation angle on X-axis. P
/composition/video/rotatey/values Float 0.0 - 1.0 -180.0 - 180.0 A rotation angle on Y-axis. P
/composition/video/rotatez/values Float 0.0 - 1.0 -180.0 - 180.0 A rotation angle on Z-axis. P

Layer

You can use /layer<number>/ instead of /activelayer/.
Example, you can address the opacity of layer one in two ways:

/layer1/video/opacity/values #deck focus.
/activelayer/video/opacity/values #layer focus.
Address OSC Type OSC Range Range Description Type
/layer1/select Int 0 or 1 Select layer. E
/layer1/clear Int 0 or 1 Clear the playing clip from this layer. E
/layer1/solo Int 0 or 1 Show the layer, the other layers fade out. T
/layer1/bypassed Int 0 or 1 Make the layer invisible. T
/layer1/movedown Int 0 or 1 Move layer down. E
/layer1/moveup Int 0 or 1 Move layer up. E
/layer1/video/mixeroptionindex Int 0 to 2 Layer blend mode. P
/layer1/video/mixeroption1 Int 0 to 47 Select layer blend mode.
Range of mixeroption: 1-3
P
/layer1/video/opacity/values Float 0.0 - 1.0 The opacity of the layer. P
/layer1/audio/volume/values Float 0.0 - 1.0 The volume of the layer. P
/layer1/opacityandvolume Float 0.0 - 1.0 The opacity and volume of the layer. P
/layer1/group Int 0 to 2 Assign layer to crossfader bus.
0: N/A
1: bus A
2: bus B
P
/layer1/transitiontime Float 0.0 - 1.0 0.0 - 10.0 The duration of the transition.
unit: second
P
/layer1/video/transitionmixeroption Int 0 to 44 Select a transition blend mode. P

Transport

If the layer's clip is video.
Address OSC Type OSC Range Range Description Type
/layer1/video/position/speed Float 0.0 - 1.0 0.0 - 10.0 The playback speed. 1 is the normal rate. 2 is twice as fast. P
/layer1/video/tempo/beats Float 0.0 - 1.0 1.0 - 10000.0 Number of beats. P
/layer1/video/position/playmode Int 0 to 3 The play mode.
0: Loop
1: Bounce
2: Play once
3: Play once and hold
P
/layer1/video/position/direction Int 0 to 3 The direction the clip plays.
0: Backward
1: Forward
2: Pause
3: Random
P
/layer1/video/position/values Float 0.0 - 1.0 0.0 - duration The playback position of the clip. unit of duration: mili second P
If the layer's clip is audio-visual.
Address OSC Type OSC Range Range Description Type
/layer1/audio/pitch/values Float 0.0 - 1.0 0.0 - 2.0 The pitch (speed). 1 is the normal rate. 2 is twice as fast. P
/layer1/audio/tempo/beats Float 0.0 - 1.0 1.0 - 10000.0 Number of beats. P
/layer1/audio/position/playmode Int 0 to 3 The play mode.
0: Loop
1: Bounce
2: Play once
3: Play once and hold
P
/layer1/audio/position/direction Int 0 to 3 The direction the clip plays.
0: Backward
1: Forward
2: Pause
3: Random
P
/layer1/audio/position/values Float 0.0 - 1.0 0.0 - duration The playback position of the clip.
unit of duration: mili second
P

Dashboard

Address OSC Type OSC Range Range Description Type
/layer1/name String Then name of layer. S
/layer1/link1/values Float 0.0 - 1.0 A value of dial on the dashboard.
number of link: 1-8
P

Auto Pilot

Address OSC Type OSC Range Range Description Type
/layer1/autopilot/action Int 0 to 3 Action of auto pilot.
0: Backwards
1: Pause
2: Forwards
3: Random
P

Audio

Address OSC Type OSC Range Range Description Type
/layer1/audio/volume/values Float 0.0 - 1.0 A volume. P
/layer1/audio/pan/values Float 0.0 - 1.0 -1.0 - 1.0 A direction to pan. P

Transform

Address OSC Type OSC Range Range Description Type
/layer1/video/mixeroption4 Int 0 to 47 Layer blend mode. P
/layer1/video/opacity/values Float 0.0 - 1.0 The opacity of the layer. P
/layer1/video/width/values Float 0.0 - 1.0 0.0 - 16384.0 The width. P
/layer1/video/height/values Float 0.0 - 1.0 0.0 - 16384.0 The height. P
/layer1/video/scale/values Float 0.0 - 1.0 0.0 - 1000.0 The scale.
unit: %
P
/layer1/video/positionx/values Float 0.0 - 1.0 -16384.0 - 16384.0 The position on X-axis. P
/layer1/video/positiony/values Float 0.0 - 1.0 -16384.0 - 16384.0 The position on Y-axis. P
/layer1/video/rotatex/values Float 0.0 - 1.0 -180.0 - 180.0 A rotation angle on X-axis. P
/layer1/video/rotatey/values Float 0.0 - 1.0 -180.0 - 180.0 A rotation angle on Y-axis. P
/layer1/video/rotatez/values Float 0.0 - 1.0 -180.0 - 180.0 A rotation angle on Z-axis. P
/layer1/video/anchorx/values Float 0.0 - 1.0 -8192.0 - 8192.0 The x origin. P
/layer1/video/anchory/values Float 0.0 - 1.0 -8192.0 - 8192.0 The y origin. P
/layer1/video/anchorz/values Float 0.0 - 1.0 -8192.0 - 8192.0 The z origin. P

BPM Clock

Address OSC Type OSC Range Range Description Type
/playbackcontroller/bpm Float 0.0 - 1.0 2.0 - 500.0 The BPM value. P
/playbackcontroller/timingdec Int 0 or 1 Increment the BPM value by 1. E
/playbackcontroller/timinginc Int 0 or 1 Decrement the BPM value by 1. E
/playbackcontroller/timingdividetwo Int 0 or 1 To divide the current BPM in half. E
/playbackcontroller/timingmulttwo Int 0 or 1 To double the current BPM. E
/playbackcontroller/tap Int 0 or 1 BPM tapper E
/playbackcontroller/resync Int 0 or 1 Resets the BPM clock. E
/playbackcontroller/paused Int 0 or 1 Pause the BPM clock. E

Column

Address OSC Type OSC Range Range Description Type
/track1/connect Int 0 or 1 Trigger this clip. E

Deck

Address OSC Type OSC Range Range Description Type
/composition/deck1/select Int 0 or 1 Switch to the deck. E

Clip

You can use /layer<number>/ instead of /activelayer/.
Example, you can address the playback position of clip one in two ways:

/layer1/clip/position/values #deck focus.
/activelayer/clip/position/values #layer focus.
Address OSC Type OSC Range Range Description Type
/layer1/clip1/connect Int 0 or 1 Trigger the clip. E
/layer1/clip1/preview Int 0 or 1 Preview the clip. E
/layer1/clip1/name String The name of the clip. S
/layer1/clip1/link1/values Float 0.0 - 1.0 A value of dial on the dashboard.
number of link: 1-8
P
/layer1/clip1/quicklook Int 0 or 1 Shows the clip in a side window. E

Transport

Address OSC Type OSC Range Range Description Type
/layer1/clip1/video/tempo/timelinemode Int 0 to 2 Transport mode.
0: Timeline
1: BPM Sync
2: Autonomous
P
/layer1/clip1/video/position/values Float 0.0 - 1.0 0.0 - duration The playback position of the clip. unit of duration: mili second P
/layer1/clip1/video/position/direction Int 0 to 3 The direction the clip plays.
0: Backward
1: Forward
2: Pause
3: Random
P
/layer1/clip1/video/position/playmode Int 0 to 3 The play mode.
0: Loop
1: Bounce
2: Play once
3: Play once and hold
P

Transport mode on Arena.

Address OSC Type OSC Range Range Description Type
/layer1/clip1/video/tempo/timelinemode Int 0 to 4 Transport mode.
0: Timeline
1: BPM Sync
2: Autonomous
3: SMPTE1
4: SMPTE2
P

Timeline only

If you select the Timelime in Transport mode.

Address OSC Type OSC Range Range Description Type
/layer1/clip1/video/position/playmodeaway Int 0 to 1 Play mode.
0: Restart
1: Continue
P
/layer1/clip1/video/position/speed Float 0.0 - 1.0 0.0 - 10.0 The playback speed. P

BPM Sync only

If you select the BPM Sync in Transport mode.

Address OSC Type OSC Range Range Description Type
/layer1/clip1/video/tempo/beats Float 0.0 - 1.0 1.0 - 10000.0 Number of beats. P
/layer1/clip1/timingdividetwo Int 0 or 1 To divide the playback BPM in half. E
/layer1/clip1/timingmulttwo Int 0 or 1 To double the playback BPM. E
/layer1/clip1/video/beatloop Int 0 to 7 BeatLooper.
0: Off
1: 4Beat
2: 2Beat
3: 1Beat
4: 1/2Beat
5: 1/4Beat
6: 1/3Beat
7: 1/6Beat
P

SMPTE (Arena only)

If you select the SMPTE in Transport mode.

Address OSC Type OSC Range Range Description Type
/composition/audio/smpteframeoffset1 Float 0.0 - 1.0 -150.0 - 150.0 SMPTE input delay compensation.
unit: frame.
number of smpteframeoffset: 1-2
P
/layer1/clip1/video/tempo/smpte1quickselect Int 0 or 1 Switch SMPTE input.
number of smpte1quickselect: 1-2
E

Cue Points

Address OSC Type OSC Range Range Description Type
/layer1/clip1/video/position/pointsofinterest Int 0 to 5 Sets a cue point. E
/layer1/clip1/video/position/jumptopointsofinterest Int 0 to 5 Jump to the cue point. E

Parameters

FFGL, Quartz Composer, Flash.

Address OSC Type OSC Range Range Description Type
/layer1/clip1/video/param1/values Float 0.0 - 1.0 The published parameter. P

Audio

Address OSC Type OSC Range Range Description Type
/layer1/clip1/audio/volume/values Float 0.0 - 1.0 -40.0 - 12.0 The volume of the audio track. P
/layer1/clip1/audio/pan/values Float 0.0 - 1.0 -1.0 - 1.0 A direction to pan of the audio track. P

Video

Address OSC Type OSC Range Range Description Type
/layer1/clip1/video/scaletofit Int 0 or 1 Scale the video to the size of the composition E
/layer1/clip1/video/rscale Int 0 or 1 Switch the red color channel in the video on or off. E
/layer1/clip1/video/gscale Int 0 or 1 Switch the green color channel in the video on or off. E
/layer1/clip1/video/bscale Int 0 or 1 Switch the blue color channel in the video on or off. E
/layer1/clip1/video/ascale Int 0 or 1 Switch the alpha color channel in the video on or off. E

Transform

Address OSC Type OSC Range Range Description Type
/layer1/clip1/video/opacity/values Float 0.0 - 1.0 The opacity of the video. P
/layer1/clip1/video/width/values Float 0.0 - 1.0 0.0 - 16384.0 The width. P
/layer1/clip1/video/height/values Float 0.0 - 1.0 0.0 - 16384.0 The height. P
/layer1/clip1/video/scale/values Float 0.0 - 1.0 0.0 - 1000.0 The scale.
unit: %
P
/layer1/clip1/video/positionx/values Float 0.0 - 1.0 -16384.0 - 16384.0 The position on X-axis. P
/layer1/clip1/video/positiony/values Float 0.0 - 1.0 -16384.0 - 16384.0 The position on Y-axis. P
/layer1/clip1/video/rotatex/values Float 0.0 - 1.0 -180.0 - 180.0 A rotation angle on X-axis. P
/layer1/clip1/video/rotatey/values Float 0.0 - 1.0 -180.0 - 180.0 A rotation angle on Y-axis. P
/layer1/clip1/video/rotatez/values Float 0.0 - 1.0 -180.0 - 180.0 A rotation angle on Z-axis. P
/layer1/clip1/video/anchorx/values Float 0.0 - 1.0 -8192.0 - 8192.0 The x origin. P
/layer1/clip1/video/anchory/values Float 0.0 - 1.0 -8192.0 - 8192.0 The y origin. P
/layer1/clip1/video/anchorz/values Float 0.0 - 1.0 -8192.0 - 8192.0 The z origin. P

Effects

You can use on Composition, Layer, Clip.

Composition Audio Effects

Address OSC Type OSC Range Range Description Type
/composition/audio/effect1/bypassed Int 0 or 1 Bypass effect. T
/composition/audio/effect1/drywet/values Float 0.0 - 1.0 Dry Wet. P
/composition/audio/effect1/param1/values Float 0.0 - 1.0 A value of the parameter. P

Composition Video Effects

Address OSC Type OSC Range Range Description Type
/composition/video/effect1/bypassed Int 0 or 1 Bypass effect. T
/composition/video/effect1/mixer Int 0 to 47 Effect blend mode. P
/composition/video/effect1/opacity/values Float 0.0 - 1.0 The opacity of the effect. P
/composition/video/effect1/param1/values Float 0.0 - 1.0 A value of the parameter. P

Layer Audio Effects

Address OSC Type OSC Range Range Description Type
/layer1/audio/effect1/bypassed Int 0 or 1 Bypass effect. T
/layer1/audio/effect1/drywet/values Float 0.0 - 1.0 Dry Wet. P
/layer1/audio/effect1/param1/values Float 0.0 - 1.0 A value of the parameter. P

Layer Video Effects

Address OSC Type OSC Range Range Description Type
/layer1/video/effect1/bypassed Int 0 or 1 Bypass effect T
/layer1/video/effect1/mixer Int 0 to 47 Effect blend mode. P
/layer1/video/effect1/opacity/values Float 0.0 - 1.0 The opacity of the effect. P
/layer1/video/effect1/param1/values Float 0.0 - 1.0 A value of the parameter. P

Clip Audio Effects

Address OSC Type OSC Range Range Description Type
/layer1/clip1/audio/effect1/bypassed Int 0 or 1 Bypass effect. T
/layer1/clip1/audio/effect1/drywet/values Float 0.0 - 1.0 Dry Wet. P
/layer1/clip1/audio/effect1/param1/values Float 0.0 - 1.0 A value of the parameter. P

Clip Video Effects

Address OSC Type OSC Range Range Description Type
/layer1/clip1/video/effect1/bypassed Int 0 or 1 Bypass effects. T
/layer1/clip1/video/effect1/mixer Int 0 to 47 Effects blend mode. P
/layer1/clip1/video/effect1/opacity/values Float 0.0 - 1.0 The opacity of the effects. P
/layer1/clip1/video/effect1/param1/values Float 0.0 - 1.0 A value of the parameter. P

Animating Parameters

You can use on Effects, Transform, etc.

Timeline

Address OSC Type OSC Range Range Description Type
/composition/video/effect1/param1/direction Int 0 to 3 The direction the timeline.
0: Backward
1: Forward
2: Pause
3: Random
P
/composition/video/effect1/param1/playmode Int 0 to 3 The play mode.
0: Loop
1: Bounce
2: Play once
3: Play once and hold
P
/composition/video/effect1/param1/playmodeaway Int 0 to 1 Play mode.
0: Restart
1: Continue
P
/composition/video/effect1/param1/speed Float 0.0 - 1.0 0.0 - 10.0 The speed of the timeline. 1 is the normal rate. 2 is twice as fast. P

BPM Sync

Address OSC Type OSC Range Range Description Type
/composition/video/effect1/param1/linkmultiplier Float 0.0 - 1.0 1.0 - 4096.0 Number of beats. P
/composition/video/effect1/param1/linkmultiplierdividetwo Int 0 or 1 To divide the BPM in half. E
/composition/video/effect1/param1/linkmultipliermulttwo Int 0 or 1 To double the BPM. E
/composition/video/effect1/param1/direction Int 0 to 3 The direction the timeline.
0: Backward
1: Forward
P
/composition/video/effect1/param1/playmode Int 0 to 3 The play mode.
0: Loop
1: Bounce
2: Play once
3: Play once and hold
P

Audio FFT

Address OSC Type OSC Range Range Description Type
/composition/video/effect1/param1/modifier/gainfall/option Int 0 to 3 Way reflected in the parameters of the FFT value.
0: Low to high
1: High to low
2: Add up (reverse) 3:Add up
P
/composition/video/effect1/param1/modifier/gainfall/gain Float 0.0 - 1.0 0.0 - 10.0 A value of the Gain control. P
/composition/video/effect1/param1/modifier/gainfall/fallback Float 0.0 - 1.0 0.0 - 1.0 A value of the Fall control. P

Author

Tobetchi

Developer at ART Teknika Inc. / VJ

スポンサーリンク