|
461 | 461 | {
|
462 | 462 | "description": "Unknown state.",
|
463 | 463 | "enumIdentifier": "OBS_WEBSOCKET_OUTPUT_UNKNOWN",
|
464 |
| - "rpcVersion": 1, |
465 |
| - "deprecated": true, |
| 464 | + "rpcVersion": "1", |
| 465 | + "deprecated": false, |
466 | 466 | "initialVersion": "5.0.0",
|
467 | 467 | "enumValue": "OBS_WEBSOCKET_OUTPUT_UNKNOWN"
|
468 | 468 | },
|
469 | 469 | {
|
470 | 470 | "description": "The output is starting.",
|
471 | 471 | "enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STARTING",
|
472 |
| - "rpcVersion": 1, |
473 |
| - "deprecated": true, |
| 472 | + "rpcVersion": "1", |
| 473 | + "deprecated": false, |
474 | 474 | "initialVersion": "5.0.0",
|
475 | 475 | "enumValue": "OBS_WEBSOCKET_OUTPUT_STARTING"
|
476 | 476 | },
|
477 | 477 | {
|
478 | 478 | "description": "The input has started.",
|
479 | 479 | "enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STARTED",
|
480 |
| - "rpcVersion": 1, |
481 |
| - "deprecated": true, |
| 480 | + "rpcVersion": "1", |
| 481 | + "deprecated": false, |
482 | 482 | "initialVersion": "5.0.0",
|
483 | 483 | "enumValue": "OBS_WEBSOCKET_OUTPUT_STARTED"
|
484 | 484 | },
|
485 | 485 | {
|
486 | 486 | "description": "The output is stopping.",
|
487 | 487 | "enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STOPPING",
|
488 |
| - "rpcVersion": 1, |
489 |
| - "deprecated": true, |
| 488 | + "rpcVersion": "1", |
| 489 | + "deprecated": false, |
490 | 490 | "initialVersion": "5.0.0",
|
491 | 491 | "enumValue": "OBS_WEBSOCKET_OUTPUT_STOPPING"
|
492 | 492 | },
|
493 | 493 | {
|
494 | 494 | "description": "The output has stopped.",
|
495 | 495 | "enumIdentifier": "OBS_WEBSOCKET_OUTPUT_STOPPED",
|
496 |
| - "rpcVersion": 1, |
497 |
| - "deprecated": true, |
| 496 | + "rpcVersion": "1", |
| 497 | + "deprecated": false, |
498 | 498 | "initialVersion": "5.0.0",
|
499 | 499 | "enumValue": "OBS_WEBSOCKET_OUTPUT_STOPPED"
|
500 | 500 | },
|
501 | 501 | {
|
502 | 502 | "description": "The output has disconnected and is reconnecting.",
|
503 | 503 | "enumIdentifier": "OBS_WEBSOCKET_OUTPUT_RECONNECTING",
|
504 |
| - "rpcVersion": 1, |
505 |
| - "deprecated": true, |
| 504 | + "rpcVersion": "1", |
| 505 | + "deprecated": false, |
506 | 506 | "initialVersion": "5.0.0",
|
507 | 507 | "enumValue": "OBS_WEBSOCKET_OUTPUT_RECONNECTING"
|
508 | 508 | },
|
509 | 509 | {
|
510 | 510 | "description": "The output has reconnected successfully.",
|
511 | 511 | "enumIdentifier": "OBS_WEBSOCKET_OUTPUT_RECONNECTED",
|
512 |
| - "rpcVersion": 1, |
513 |
| - "deprecated": true, |
| 512 | + "rpcVersion": "1", |
| 513 | + "deprecated": false, |
514 | 514 | "initialVersion": "5.1.0",
|
515 | 515 | "enumValue": "OBS_WEBSOCKET_OUTPUT_RECONNECTED"
|
516 | 516 | },
|
517 | 517 | {
|
518 | 518 | "description": "The output is now paused.",
|
519 | 519 | "enumIdentifier": "OBS_WEBSOCKET_OUTPUT_PAUSED",
|
520 |
| - "rpcVersion": 1, |
521 |
| - "deprecated": true, |
| 520 | + "rpcVersion": "1", |
| 521 | + "deprecated": false, |
522 | 522 | "initialVersion": "5.1.0",
|
523 | 523 | "enumValue": "OBS_WEBSOCKET_OUTPUT_PAUSED"
|
524 | 524 | },
|
525 | 525 | {
|
526 | 526 | "description": "The output has been resumed (unpaused).",
|
527 | 527 | "enumIdentifier": "OBS_WEBSOCKET_OUTPUT_RESUMED",
|
528 |
| - "rpcVersion": 1, |
529 |
| - "deprecated": true, |
| 528 | + "rpcVersion": "1", |
| 529 | + "deprecated": false, |
530 | 530 | "initialVersion": "5.0.0",
|
531 | 531 | "enumValue": "OBS_WEBSOCKET_OUTPUT_RESUMED"
|
532 | 532 | }
|
|
538 | 538 | {
|
539 | 539 | "description": "No action.",
|
540 | 540 | "enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NONE",
|
541 |
| - "rpcVersion": 1, |
542 |
| - "deprecated": true, |
| 541 | + "rpcVersion": "1", |
| 542 | + "deprecated": false, |
543 | 543 | "initialVersion": "5.0.0",
|
544 | 544 | "enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NONE"
|
545 | 545 | },
|
546 | 546 | {
|
547 | 547 | "description": "Play the media input.",
|
548 | 548 | "enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY",
|
549 |
| - "rpcVersion": 1, |
550 |
| - "deprecated": true, |
| 549 | + "rpcVersion": "1", |
| 550 | + "deprecated": false, |
551 | 551 | "initialVersion": "5.0.0",
|
552 | 552 | "enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PLAY"
|
553 | 553 | },
|
554 | 554 | {
|
555 | 555 | "description": "Pause the media input.",
|
556 | 556 | "enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE",
|
557 |
| - "rpcVersion": 1, |
558 |
| - "deprecated": true, |
| 557 | + "rpcVersion": "1", |
| 558 | + "deprecated": false, |
559 | 559 | "initialVersion": "5.0.0",
|
560 | 560 | "enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PAUSE"
|
561 | 561 | },
|
562 | 562 | {
|
563 | 563 | "description": "Stop the media input.",
|
564 | 564 | "enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP",
|
565 |
| - "rpcVersion": 1, |
566 |
| - "deprecated": true, |
| 565 | + "rpcVersion": "1", |
| 566 | + "deprecated": false, |
567 | 567 | "initialVersion": "5.0.0",
|
568 | 568 | "enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_STOP"
|
569 | 569 | },
|
570 | 570 | {
|
571 | 571 | "description": "Restart the media input.",
|
572 | 572 | "enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART",
|
573 |
| - "rpcVersion": 1, |
574 |
| - "deprecated": true, |
| 573 | + "rpcVersion": "1", |
| 574 | + "deprecated": false, |
575 | 575 | "initialVersion": "5.0.0",
|
576 | 576 | "enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_RESTART"
|
577 | 577 | },
|
578 | 578 | {
|
579 | 579 | "description": "Go to the next playlist item.",
|
580 | 580 | "enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NEXT",
|
581 |
| - "rpcVersion": 1, |
582 |
| - "deprecated": true, |
| 581 | + "rpcVersion": "1", |
| 582 | + "deprecated": false, |
583 | 583 | "initialVersion": "5.0.0",
|
584 | 584 | "enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_NEXT"
|
585 | 585 | },
|
586 | 586 | {
|
587 | 587 | "description": "Go to the previous playlist item.",
|
588 | 588 | "enumIdentifier": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PREVIOUS",
|
589 |
| - "rpcVersion": 1, |
590 |
| - "deprecated": true, |
| 589 | + "rpcVersion": "1", |
| 590 | + "deprecated": false, |
591 | 591 | "initialVersion": "5.0.0",
|
592 | 592 | "enumValue": "OBS_WEBSOCKET_MEDIA_INPUT_ACTION_PREVIOUS"
|
593 | 593 | }
|
|
3472 | 3472 | "requestFields": [],
|
3473 | 3473 | "responseFields": []
|
3474 | 3474 | },
|
| 3475 | + { |
| 3476 | + "description": "Splits the current file being recorded into a new file.", |
| 3477 | + "requestType": "SplitRecordFile", |
| 3478 | + "complexity": 2, |
| 3479 | + "rpcVersion": "1", |
| 3480 | + "deprecated": false, |
| 3481 | + "initialVersion": "5.5.0", |
| 3482 | + "category": "record", |
| 3483 | + "requestFields": [], |
| 3484 | + "responseFields": [] |
| 3485 | + }, |
| 3486 | + { |
| 3487 | + "description": "Adds a new chapter marker to the file currently being recorded.\n\nNote: As of OBS 30.2.0, the only file format supporting this feature is Hybrid MP4.", |
| 3488 | + "requestType": "CreateRecordChapter", |
| 3489 | + "complexity": 2, |
| 3490 | + "rpcVersion": "1", |
| 3491 | + "deprecated": false, |
| 3492 | + "initialVersion": "5.5.0", |
| 3493 | + "category": "record", |
| 3494 | + "requestFields": [ |
| 3495 | + { |
| 3496 | + "valueName": "chapterName", |
| 3497 | + "valueType": "String", |
| 3498 | + "valueDescription": "Name of the new chapter", |
| 3499 | + "valueRestrictions": null, |
| 3500 | + "valueOptional": true, |
| 3501 | + "valueOptionalBehavior": "Unknown" |
| 3502 | + } |
| 3503 | + ], |
| 3504 | + "responseFields": [] |
| 3505 | + }, |
3475 | 3506 | {
|
3476 | 3507 | "description": "Gets a list of all scene items in a scene.\n\nScenes only",
|
3477 | 3508 | "requestType": "GetSceneItemList",
|
|
6046 | 6077 | }
|
6047 | 6078 | ]
|
6048 | 6079 | },
|
| 6080 | + { |
| 6081 | + "description": "The record output has started writing to a new file. For example, when a file split happens.", |
| 6082 | + "eventType": "RecordFileChanged", |
| 6083 | + "eventSubscription": "Outputs", |
| 6084 | + "complexity": 2, |
| 6085 | + "rpcVersion": "1", |
| 6086 | + "deprecated": false, |
| 6087 | + "initialVersion": "5.5.0", |
| 6088 | + "category": "outputs", |
| 6089 | + "dataFields": [ |
| 6090 | + { |
| 6091 | + "valueName": "newOutputPath", |
| 6092 | + "valueType": "String", |
| 6093 | + "valueDescription": "File name that the output has begun writing to" |
| 6094 | + } |
| 6095 | + ] |
| 6096 | + }, |
6049 | 6097 | {
|
6050 | 6098 | "description": "The state of the replay buffer output has changed.",
|
6051 | 6099 | "eventType": "ReplayBufferStateChanged",
|
|
0 commit comments