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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
cacheUsage()
Gets information about cache usage.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
304 305 306 307 308 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
loadCurrentSourcesChangedFrames()
Loads changed frames for current sources.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
154 155 156 157 158 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
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 | |
scale()
Gets the current view scale.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
340 341 342 343 344 | |
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 | |
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 | |
setActiveState()
Sets RV to an active state.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
364 365 366 367 368 | |
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 | |
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 | |
setInactiveState()
Sets RV to an inactive state.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
220 221 222 223 224 | |
setScale(scale)
Sets the current view scale.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
352 353 354 355 356 | |
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 | |
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 | |
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 | |
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 | |
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 | |
stepBackward()
Steps backward by one frame.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
226 227 228 229 230 | |
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 | |
stepBackward10()
Steps backward by 10 frames.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
142 143 144 145 146 | |
stepBackward100()
Steps backward by 100 frames.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
196 197 198 199 200 | |
stepForward()
Steps forward by one frame.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
478 479 480 481 482 | |
stepForward1()
Steps forward by one frame.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
424 425 426 427 428 | |
stepForward10()
Steps forward by 10 frames.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
430 431 432 433 434 | |
stepForward100()
Steps forward by 100 frames.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
208 209 210 211 212 | |
toggleFilter(filterName)
Toggles a specific filter.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
244 245 246 247 248 | |
toggleForwardsBackwards()
Toggles playback direction.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
412 413 414 415 416 | |
toggleFullScreen()
Toggles full screen mode.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
280 281 282 283 284 | |
toggleMotionScope()
Toggles the motion scope overlay.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
316 317 318 319 320 | |
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 | |
togglePlay()
Toggles playback (play/pause).
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
376 377 378 379 380 | |
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 | |
togglePlayVerbose()
Toggles playback with verbose output.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
400 401 402 403 404 | |
toggleRealtime()
Toggles realtime playback mode.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
310 311 312 313 314 | |
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 | |
topLevelGroup()
Gets the top-level group node.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
250 251 252 253 254 | |
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 | |
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 | |
updatePixelInfo()
Updates the displayed pixel information.
Source code in client/ayon_openrv/typing/rv/extra_commands/__init__.py
514 515 516 517 518 | |