Skip to content

extra_commands

Type hints for rv.extra_commands module.

activatePackageModeEntry(packageName, modeName)

Activates a specific mode entry within a package.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
232
233
234
235
236
def activatePackageModeEntry(packageName: str, modeName: str) -> None:
    """
    Activates a specific mode entry within a package.
    """
    ...

activateSync(connectionName)

Activates synchronization with a remote connection.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
298
299
300
301
302
def activateSync(connectionName: str) -> None:
    """
    Activates synchronization with a remote connection.
    """
    ...

appendToProp(nodeName, propName, value)

Appends a value to a node property.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
490
491
492
493
494
def appendToProp(nodeName: str, propName: str, value: Any) -> None:
    """
    Appends a value to a node property.
    """
    ...

associatedNode(nodeName, associationType)

Gets an associated node of a specific type.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
268
269
270
271
272
def associatedNode(nodeName: str, associationType: str) -> Optional[str]:
    """
    Gets an associated node of a specific type.
    """
    ...

associatedNodes(nodeName, associationType)

Gets all associated nodes of a specific type.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
406
407
408
409
410
def associatedNodes(nodeName: str, associationType: str) -> List[str]:
    """
    Gets all associated nodes of a specific type.
    """
    ...

associatedVideoDevice(sourceNode)

Gets the associated video device for a source node.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
508
509
510
511
512
def associatedVideoDevice(sourceNode: str) -> str:
    """
    Gets the associated video device for a source node.
    """
    ...

cacheUsage()

Gets information about cache usage.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
304
305
306
307
308
def cacheUsage() -> Dict[str, Any]:
    """
    Gets information about cache usage.
    """
    ...

centerResizeFit()

Centers the view and resizes to fit the current image.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
448
449
450
451
452
def centerResizeFit() -> None:
    """
    Centers the view and resizes to fit the current image.
    """
    ...

cprop(nodeName, propName)

Gets a property value as a string (convenience function).

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
484
485
486
487
488
def cprop(nodeName: str, propName: str) -> str:
    """
    Gets a property value as a string (convenience function).
    """
    ...

currentImageAspect()

Gets the aspect ratio of the current image.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
286
287
288
289
290
def currentImageAspect() -> float:
    """
    Gets the aspect ratio of the current image.
    """
    ...

cycleNodeInputs(nodeName)

Cycles through the inputs of a node.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
274
275
276
277
278
def cycleNodeInputs(nodeName: str) -> None:
    """
    Cycles through the inputs of a node.
    """
    ...

deactivatePackageModeEntry(packageName, modeName)

Deactivates a specific mode entry within a package.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
256
257
258
259
260
def deactivatePackageModeEntry(packageName: str, modeName: str) -> None:
    """
    Deactivates a specific mode entry within a package.
    """
    ...

deleteAnnotation(frame)

Delete the annotation for a specific frame.

Parameters:

Name Type Description Default
frame int

The frame number.

required
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
88
89
90
91
92
93
94
95
def deleteAnnotation(frame: int) -> None:
    """
    Delete the annotation for a specific frame.

    Args:
        frame (int): The frame number.
    """
    ...

displayFeedback(message)

Displays feedback message (older version, displayFeedback2 preferred).

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
370
371
372
373
374
def displayFeedback(message: str) -> None:
    """
    Displays feedback message (older version, displayFeedback2 preferred).
    """
    ...

displayFeedback2(message, duration=2.0)

Displays feedback message in the UI.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
172
173
174
175
176
def displayFeedback2(message: str, duration: float = 2.0) -> None:
    """
    Displays feedback message in the UI.
    """
    ...

existsInProp(nodeName, propName, value)

Checks if a value exists in a node property.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
502
503
504
505
506
def existsInProp(nodeName: str, propName: str, value: Any) -> bool:
    """
    Checks if a value exists in a node property.
    """
    ...

findAnnotatedFrames()

Return a list of frame numbers that have annotations.

Returns:

Type Description
List[int]

List[int]: A list of frame numbers with annotations.

List[int]

The array is not sorted and some frames may appear more than once.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
 6
 7
 8
 9
10
11
12
13
14
def findAnnotatedFrames() -> List[int]:
    """
    Return a list of frame numbers that have annotations.

    Returns:
        List[int]: A list of frame numbers with annotations.
        The array is not sorted and some frames may appear more than once.
    """
    ...

frameImage()

Frames the current image in the view.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
292
293
294
295
296
def frameImage() -> None:
    """
    Frames the current image in the view.
    """
    ...

getAllNodesOfType(nodeType)

Find all nodes of a specific type in the entire session.

Parameters:

Name Type Description Default
nodeType str

The type of node to search for.

required

Returns:

Type Description
List[str]

List[str]: A list of node names of the specified type.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
108
109
110
111
112
113
114
115
116
117
118
def getAllNodesOfType(nodeType: str) -> List[str]:
    """
    Find all nodes of a specific type in the entire session.

    Args:
        nodeType (str): The type of node to search for.

    Returns:
        List[str]: A list of node names of the specified type.
    """
    ...

getAnnotationText(frame)

Get the annotation text for a specific frame.

Parameters:

Name Type Description Default
frame int

The frame number.

required

Returns:

Name Type Description
str str

The annotation text for the frame.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
64
65
66
67
68
69
70
71
72
73
74
def getAnnotationText(frame: int) -> str:
    """
    Get the annotation text for a specific frame.

    Args:
        frame (int): The frame number.

    Returns:
        str: The annotation text for the frame.
    """
    ...

getAnnotations()

Get all annotations in the current session.

Returns:

Type Description
Dict[int, str]

Dict[int, str]: A dictionary mapping frame numbers to annotation text.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
 98
 99
100
101
102
103
104
105
def getAnnotations() -> Dict[int, str]:
    """
    Get all annotations in the current session.

    Returns:
        Dict[int, str]: A dictionary mapping frame numbers to annotation text.
    """
    ...

getGroupNodesOfType(groupNode, nodeType, recursive=False)

Find nodes of a specific type within a group, optionally recursively.

Parameters:

Name Type Description Default
groupNode str

The group node to search in.

required
nodeType str

The type of node to search for.

required
recursive bool

Whether to search recursively in subgroups.

False

Returns:

Type Description
List[str]

List[str]: A list of node names of the specified type.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
121
122
123
124
125
126
127
128
129
130
131
132
133
def getGroupNodesOfType(groupNode: str, nodeType: str, recursive: bool = False) -> List[str]:
    """
    Find nodes of a specific type within a group, optionally recursively.

    Args:
        groupNode (str): The group node to search in.
        nodeType (str): The type of node to search for.
        recursive (bool, optional): Whether to search recursively in subgroups.

    Returns:
        List[str]: A list of node names of the specified type.
    """
    ...

inputNodeUserNameAtFrame(nodeName, frame, userName)

Gets the input node user name at a specific frame.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
178
179
180
181
182
def inputNodeUserNameAtFrame(nodeName: str, frame: int, userName: str) -> str:
    """
    Gets the input node user name at a specific frame.
    """
    ...

isFrameMarked(frame)

Check if a specific frame is marked.

Parameters:

Name Type Description Default
frame int

The frame number to check.

required

Returns:

Name Type Description
bool bool

True if the frame is marked, False otherwise.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
51
52
53
54
55
56
57
58
59
60
61
def isFrameMarked(frame: int) -> bool:
    """
    Check if a specific frame is marked.

    Args:
        frame (int): The frame number to check.

    Returns:
        bool: True if the frame is marked, False otherwise.
    """
    ...

isNarrowed()

Checks if the view is narrowed to a range.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
322
323
324
325
326
def isNarrowed() -> bool:
    """
    Checks if the view is narrowed to a range.
    """
    ...

isPlayable()

Checks if the current session is playable.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
328
329
330
331
332
def isPlayable() -> bool:
    """
    Checks if the current session is playable.
    """
    ...

isPlayingBackwards()

Checks if playback is currently moving backwards.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
334
335
336
337
338
def isPlayingBackwards() -> bool:
    """
    Checks if playback is currently moving backwards.
    """
    ...

isPlayingForwards()

Checks if playback is currently moving forwards.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
214
215
216
217
218
def isPlayingForwards() -> bool:
    """
    Checks if playback is currently moving forwards.
    """
    ...

isSessionEmpty()

Checks if the current session is empty.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
394
395
396
397
398
def isSessionEmpty() -> bool:
    """
    Checks if the current session is empty.
    """
    ...

isViewNode(nodeName)

Checks if a node is the current view node.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
238
239
240
241
242
def isViewNode(nodeName: str) -> bool:
    """
    Checks if a node is the current view node.
    """
    ...

loadCurrentSourcesChangedFrames()

Loads changed frames for current sources.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
154
155
156
157
158
def loadCurrentSourcesChangedFrames() -> None:
    """
    Loads changed frames for current sources.
    """
    ...

markFrameEnd()

Get the end frame of the current mark range.

Returns:

Name Type Description
int int

The end frame of the mark range.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
41
42
43
44
45
46
47
48
def markFrameEnd() -> int:
    """
    Get the end frame of the current mark range.

    Returns:
        int: The end frame of the mark range.
    """
    ...

markFrameStart()

Get the start frame of the current mark range.

Returns:

Name Type Description
int int

The start frame of the mark range.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
31
32
33
34
35
36
37
38
def markFrameStart() -> int:
    """
    Get the start frame of the current mark range.

    Returns:
        int: The start frame of the mark range.
    """
    ...

minorModeIsLoaded(modeName)

Checks if a minor mode is loaded.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
526
527
528
529
530
def minorModeIsLoaded(modeName: str) -> bool:
    """
    Checks if a minor mode is loaded.
    """
    ...

nodesInEvalPath(nodeName)

Finds nodes in the evaluation path of a given node.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
160
161
162
163
164
def nodesInEvalPath(nodeName: str) -> List[str]:
    """
    Finds nodes in the evaluation path of a given node.
    """
    ...

nodesInGroupOfType(groupNode, nodeType)

Find all nodes of a specific type within a group.

Parameters:

Name Type Description Default
groupNode str

The group node to search in.

required
nodeType str

The type of node to search for.

required

Returns:

Type Description
List[str]

List[str]: A list of node names of the specified type.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
17
18
19
20
21
22
23
24
25
26
27
28
def nodesInGroupOfType(groupNode: str, nodeType: str) -> List[str]:
    """
    Find all nodes of a specific type within a group.

    Args:
        groupNode (str): The group node to search in.
        nodeType (str): The type of node to search for.

    Returns:
        List[str]: A list of node names of the specified type.
    """
    ...

nodesUnderPointer(x, y)

Gets the names of nodes under the mouse pointer coordinates.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
442
443
444
445
446
def nodesUnderPointer(x: int, y: int) -> List[str]:
    """
    Gets the names of nodes under the mouse pointer coordinates.
    """
    ...

numFrames()

Gets the total number of frames in the session.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
454
455
456
457
458
def numFrames() -> int:
    """
    Gets the total number of frames in the session.
    """
    ...

popInputToTop()

Pops the current input node to the top of the node graph.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
136
137
138
139
140
def popInputToTop() -> None:
    """
    Pops the current input node to the top of the node graph.
    """
    ...

recordPixelInfo(enable)

Enables or disables recording of pixel information.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
358
359
360
361
362
def recordPixelInfo(enable: bool) -> None:
    """
    Enables or disables recording of pixel information.
    """
    ...

reloadInOut()

Reloads media within the in and out points.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
148
149
150
151
152
def reloadInOut() -> None:
    """
    Reloads media within the in and out points.
    """
    ...

removeFromProp(nodeName, propName, value)

Removes a value from a node property.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
496
497
498
499
500
def removeFromProp(nodeName: str, propName: str, value: Any) -> None:
    """
    Removes a value from a node property.
    """
    ...

scale()

Gets the current view scale.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
340
341
342
343
344
def scale() -> float:
    """
    Gets the current view scale.
    """
    ...

sequenceBoundaries()

Gets the start and end frames of the current sequence.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
382
383
384
385
386
def sequenceBoundaries() -> List[int]:
    """
    Gets the start and end frames of the current sequence.
    """
    ...

set(variableName, value)

Sets the value of a variable.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
262
263
264
265
266
def set(variableName: str, value: Any) -> None:
    """
    Sets the value of a variable.
    """
    ...

setActiveState()

Sets RV to an active state.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
364
365
366
367
368
def setActiveState() -> None:
    """
    Sets RV to an active state.
    """
    ...

setAnnotationText(frame, text)

Set the annotation text for a specific frame.

Parameters:

Name Type Description Default
frame int

The frame number.

required
text str

The text to set as annotation.

required
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
77
78
79
80
81
82
83
84
85
def setAnnotationText(frame: int, text: str) -> None:
    """
    Set the annotation text for a specific frame.

    Args:
        frame (int): The frame number.
        text (str): The text to set as annotation.
    """
    ...

setDisplayProfilesFromSettings(enable)

Sets display profiles based on settings.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
520
521
522
523
524
def setDisplayProfilesFromSettings(enable: bool) -> None:
    """
    Sets display profiles based on settings.
    """
    ...

setInactiveState()

Sets RV to an inactive state.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
220
221
222
223
224
def setInactiveState() -> None:
    """
    Sets RV to an inactive state.
    """
    ...

setScale(scale)

Sets the current view scale.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
352
353
354
355
356
def setScale(scale: float) -> None:
    """
    Sets the current view scale.
    """
    ...

setTranslation(x, y)

Sets the translation of the current view.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
202
203
204
205
206
def setTranslation(x: float, y: float) -> None:
    """
    Sets the translation of the current view.
    """
    ...

setUIName(nodeName, uiName)

Sets the UI name for a node.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
166
167
168
169
170
def setUIName(nodeName: str, uiName: str) -> None:
    """
    Sets the UI name for a node.
    """
    ...

sourceFrame(sourceNode)

Gets the current frame of a specific source node.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
436
437
438
439
440
def sourceFrame(sourceNode: str) -> int:
    """
    Gets the current frame of a specific source node.
    """
    ...

sourceImageStructure(sourceNode)

Gets the image structure for a source node.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
190
191
192
193
194
def sourceImageStructure(sourceNode: str) -> Dict[str, Any]:
    """
    Gets the image structure for a source node.
    """
    ...

sourceMetaInfoAtFrame(sourceNode, frame)

Gets meta information for a source at a specific frame.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
184
185
186
187
188
def sourceMetaInfoAtFrame(sourceNode: str, frame: int) -> Dict[str, Any]:
    """
    Gets meta information for a source at a specific frame.
    """
    ...

stepBackward()

Steps backward by one frame.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
226
227
228
229
230
def stepBackward() -> None:
    """
    Steps backward by one frame.
    """
    ...

stepBackward1()

Steps backward by one frame (duplicate definition).

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
466
467
468
469
470
def stepBackward1() -> None:
    """
    Steps backward by one frame (duplicate definition).
    """
    ...

stepBackward10()

Steps backward by 10 frames.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
142
143
144
145
146
def stepBackward10() -> None:
    """
    Steps backward by 10 frames.
    """
    ...

stepBackward100()

Steps backward by 100 frames.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
196
197
198
199
200
def stepBackward100() -> None:
    """
    Steps backward by 100 frames.
    """
    ...

stepForward()

Steps forward by one frame.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
478
479
480
481
482
def stepForward() -> None:
    """
    Steps forward by one frame.
    """
    ...

stepForward1()

Steps forward by one frame.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
424
425
426
427
428
def stepForward1() -> None:
    """
    Steps forward by one frame.
    """
    ...

stepForward10()

Steps forward by 10 frames.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
430
431
432
433
434
def stepForward10() -> None:
    """
    Steps forward by 10 frames.
    """
    ...

stepForward100()

Steps forward by 100 frames.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
208
209
210
211
212
def stepForward100() -> None:
    """
    Steps forward by 100 frames.
    """
    ...

toggleFilter(filterName)

Toggles a specific filter.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
244
245
246
247
248
def toggleFilter(filterName: str) -> None:
    """
    Toggles a specific filter.
    """
    ...

toggleForwardsBackwards()

Toggles playback direction.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
412
413
414
415
416
def toggleForwardsBackwards() -> None:
    """
    Toggles playback direction.
    """
    ...

toggleFullScreen()

Toggles full screen mode.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
280
281
282
283
284
def toggleFullScreen() -> None:
    """
    Toggles full screen mode.
    """
    ...

toggleMotionScope()

Toggles the motion scope overlay.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
316
317
318
319
320
def toggleMotionScope() -> None:
    """
    Toggles the motion scope overlay.
    """
    ...

toggleMotionScopeFromState(state)

Toggles motion scope based on a boolean state.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
346
347
348
349
350
def toggleMotionScopeFromState(state: bool) -> None:
    """
    Toggles motion scope based on a boolean state.
    """
    ...

togglePlay()

Toggles playback (play/pause).

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
376
377
378
379
380
def togglePlay() -> None:
    """
    Toggles playback (play/pause).
    """
    ...

togglePlayIfNoScrub()

Toggles playback only if not currently scrubbing.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
388
389
390
391
392
def togglePlayIfNoScrub() -> None:
    """
    Toggles playback only if not currently scrubbing.
    """
    ...

togglePlayVerbose()

Toggles playback with verbose output.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
400
401
402
403
404
def togglePlayVerbose() -> None:
    """
    Toggles playback with verbose output.
    """
    ...

toggleRealtime()

Toggles realtime playback mode.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
310
311
312
313
314
def toggleRealtime() -> None:
    """
    Toggles realtime playback mode.
    """
    ...

toggleSync(connectionName)

Toggles synchronization with a remote connection.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
460
461
462
463
464
def toggleSync(connectionName: str) -> None:
    """
    Toggles synchronization with a remote connection.
    """
    ...

topLevelGroup()

Gets the top-level group node.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
250
251
252
253
254
def topLevelGroup() -> str:
    """
    Gets the top-level group node.
    """
    ...

translation()

Gets the current view translation [x, y].

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
418
419
420
421
422
def translation() -> List[float]:
    """
    Gets the current view translation [x, y].
    """
    ...

uiName(nodeName)

Gets the UI name of a node.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
472
473
474
475
476
def uiName(nodeName: str) -> str:
    """
    Gets the UI name of a node.
    """
    ...

updatePixelInfo()

Updates the displayed pixel information.

Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
514
515
516
517
518
def updatePixelInfo() -> None:
    """
    Updates the displayed pixel information.
    """
    ...