From 5daa4942e8e7645a1e375f4abd72f7d1846d7048 Mon Sep 17 00:00:00 2001 From: aatikturk Date: Sun, 5 Jun 2022 14:40:55 +0300 Subject: [PATCH] initial commit including request calls to obswebsocket --- .gitignore | 4 + LICENSE | 674 ++++++++++++ README.md | 37 + obsstudio_sdk/__init__.py | 1 + obsstudio_sdk/baseclient.py | 53 + obsstudio_sdk/reqs.py | 2000 +++++++++++++++++++++++++++++++++++ setup.py | 40 + 7 files changed, 2809 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 obsstudio_sdk/__init__.py create mode 100644 obsstudio_sdk/baseclient.py create mode 100644 obsstudio_sdk/reqs.py create mode 100644 setup.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6b90fc9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +__pycache__ +obsstudio_sdk.egg-info +dist +docs \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e72bfdd --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..92e1fc3 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# obs_sdk +### A Python SDK for OBS Studio WebSocket v5.0 + +This is a wrapper around OBS Websocket. +Not all endpoints in the official documentation are implemented. But all endpoints in the Requests section is implemented. You can find the relevant document using below link. +[obs-websocket github page](https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#Requests) + +### How to install using pip + +``` +pip install obsstudio-sdk +``` + + +### How to Use + +* Import and start using + Required parameters are as follows: + host: obs websocket server + port: port to access server + password: obs websocket server password + +``` +>>>from obsstudio_sdk.reqs import ReqClient +>>> +>>>client = ReqClient('192.168.1.1', 4444, 'somepassword') +``` + +Now you can make calls to OBS + +Example: Toggle the mute state of your Mic input + +``` +>>>cl.ToggleInputMute('Mic/Aux') +>>> + +``` \ No newline at end of file diff --git a/obsstudio_sdk/__init__.py b/obsstudio_sdk/__init__.py new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/obsstudio_sdk/__init__.py @@ -0,0 +1 @@ + diff --git a/obsstudio_sdk/baseclient.py b/obsstudio_sdk/baseclient.py new file mode 100644 index 0000000..1326f16 --- /dev/null +++ b/obsstudio_sdk/baseclient.py @@ -0,0 +1,53 @@ +import websocket +import json +import hashlib +import base64 +from random import randint + +class ObsClient(object): + def __init__(self, host, port, password): + self.host = host + self.port = port + self.password = password + self.ws = websocket.WebSocket() + self.ws.connect(f"ws://{self.host}:{self.port}") + self.server_hello = json.loads(self.ws.recv()) + + def authenticate(self): + secret = base64.b64encode( + hashlib.sha256( + (self.password + self.server_hello['d']['authentication']['salt']).encode()).digest()) + + auth = base64.b64encode( + hashlib.sha256( + (secret.decode() + self.server_hello['d']['authentication']['challenge']).encode()).digest()).decode() + + payload = { "op":1, "d": { + "rpcVersion": 1, + "authentication": auth} + } + + self.ws.send(json.dumps(payload)) + return self.ws.recv() + + def req(self, req_type, req_data=None): + if req_data == None: + payload = { + "op": 6, + "d": { + "requestType": req_type, + "requestId": randint(1, 1000) + } + } + else: + payload = { + "op": 6, + "d": { + "requestType": req_type, + "requestId": randint(1, 1000), + "requestData": req_data + } + } + self.ws.send(json.dumps(payload)) + return json.loads(self.ws.recv()) + \ No newline at end of file diff --git a/obsstudio_sdk/reqs.py b/obsstudio_sdk/reqs.py new file mode 100644 index 0000000..311a48c --- /dev/null +++ b/obsstudio_sdk/reqs.py @@ -0,0 +1,2000 @@ +import baseclient + +""" +A class to interact with obs-websocket requests +defined in official github repo +https://github.com/obsproject/obs-websocket/blob/master/docs/generated/protocol.md#Requests +""" +class ReqClient(object): + def __init__(self, host, port, password): + self.base_client = baseclient.ObsClient(host, port, password) + self.base_client.authenticate() + + def GetVersion(self): + """ + Gets data about the current plugin and RPC version. + + Response Fields + "obsVersion" : (String) + "obsWebSocketVersion" : (String) + "rpcVersion" : (Number) + "availableRequests" : (List) + "supportedImageFormats" : (List) + "platform" : (String) + "platformDescription" : (String) + + :return: The version info as a dictionary + :rtype: dict + + """ + response = self.base_client.req('GetVersion') + return response + + def GetStats(self): + """ + Gets statistics about OBS, obs-websocket, and the current session. + + Response Fields + "cpuUsage" : (Number) + "memoryUsage" : (Number) + "availableDiskSpace" : (Number) + "activeFps" : (Number) + "averageFrameRenderTime" : (Number) + "renderSkippedFrames" : (Number) + "renderTotalFrames" : (Number) + "outputSkippedFrames" : (Number) + "outputTotalFrames" : (Number) + "webSocketSessionIncomingMessages": (Number) + "webSocketSessionOutgoingMessages": (Number) + + :return: The stats info as a dictionary + :rtype: dict + """ + response = self.base_client.req('GetStats') + return response + + def BroadcastCustomEvent(self, eventData): + """ + Broadcasts a CustomEvent to all WebSocket clients. Receivers are clients which are identified and subscribed. + + :param eventData: Data payload to emit to all receivers + :type eventData: object + :return: empty response + :rtype: str + + """ + req_data = eventData + response = self.base_client.req('BroadcastCustomEvent', req_data) + return response + + def CallVendorRequest(self, vendorName, requestType, requestData): + """ + Call a request registered to a vendor. + + A vendor is a unique name registered by a + third-party plugin or script, which allows + for custom requests and events to be added + to obs-websocket. If a plugin or script + implements vendor requests or events, + documentation is expected to be provided with them. + + :param vendorName: Name of the vendor to use + :type vendorName: str + :param requestType: The request type to call + :type requestType: str + :param requestData: Object containing appropriate request data + :type requestData: object + :return: responseData + :rtype: dict + """ + response = self.base_client.req(req_type=requestType, req_data=requestData) + return response + + def GetHotkeyList(self): + """ + Gets an array of all hotkey names in OBS + + :return: hotkeys + :rtype: list[str] + """ + response = self.base_client.req('GetHotkeyList') + return response + + def TriggerHotkeyByName(self, hotkeyName): + """ + Triggers a hotkey using its name. For hotkey names + See GetHotkeyList + + :param hotkeyName: Name of the hotkey to trigger + :type hotkeyName: str + """ + payload = {'hotkeyName': hotkeyName} + response = self.base_client.req('TriggerHotkeyByName', payload) + return response + + def TriggerHotkeyByKeySequence(self,keyId, pressShift, pressCtrl, pressAlt, pressCmd): + """ + Triggers a hotkey using a sequence of keys. + + :param keyId: The OBS key ID to use. See https://github.com/obsproject/obs-studio/blob/master/libobs/obs-hotkeys.h + :type keyId: str + :param keyModifiers: Object containing key modifiers to apply. + :type keyModifiers: dict + :param keyModifiers.shift: Press Shift + :type keyModifiers.shift: bool + :param keyModifiers.control: Press CTRL + :type keyModifiers.control: bool + :param keyModifiers.alt: Press ALT + :type keyModifiers.alt: bool + :param keyModifiers.cmd: Press CMD (Mac) + :type keyModifiers.cmd: bool + """ + payload = { + 'keyId': keyId, + 'keyModifiers': { + 'shift': pressShift, + 'control': pressCtrl, + 'alt': pressAlt, + 'cmd': pressCmd + } + } + + response = self.base_client.req('TriggerHotkeyByKeySequence', payload) + return response + + def Sleep(self, sleepMillis=None, sleepFrames=None): + """ + Sleeps for a time duration or number of frames. + Only available in request batches with types SERIAL_REALTIME or SERIAL_FRAME + + :param sleepMillis: Number of milliseconds to sleep for (if SERIAL_REALTIME mode) 0 <= sleepMillis <= 50000 + :type sleepMillis: int + :param sleepFrames: Number of frames to sleep for (if SERIAL_FRAME mode) 0 <= sleepFrames <= 10000 + :type sleepFrames: int + """ + payload = { + 'sleepMillis': sleepMillis, + 'sleepFrames': sleepFrames + } + response = self.base_client.req('Sleep', payload) + return response + + def GetPersistentData(self, realm, slotName): + """ + Gets the value of a "slot" from the selected persistent data realm. + + :param realm: The data realm to select + OBS_WEBSOCKET_DATA_REALM_GLOBAL or OBS_WEBSOCKET_DATA_REALM_PROFILE + :type realm: str + :param slotName: The name of the slot to retrieve data from + :type slotName: str + :return: slotValue Value associated with the slot + :rtype: any + """ + payload = { + 'realm': realm, + 'slotName': slotName + } + response = self.base_client.req('GetPersistentData', payload) + return response + + def SetPersistentData(self, realm, slotName, slotValue): + """ + Sets the value of a "slot" from the selected persistent data realm. + + :param realm: The data realm to select. + OBS_WEBSOCKET_DATA_REALM_GLOBAL or OBS_WEBSOCKET_DATA_REALM_PROFILE + :type realm: str + :param slotName: The name of the slot to retrieve data from + :type slotName: str + :param slotValue: The value to apply to the slot + :type slotValue: any + """ + payload = { + 'realm': realm, + 'slotName': slotName, + 'slotValue': slotValue + } + response = self.base_client.req('SetPersistentData', payload) + return response + + def GetSceneCollectionList(self): + """ + Gets an array of all scene collections + + :return: sceneCollections + :rtype: list[str] + """ + response = self.base_client.req('GetSceneCollectionList') + return response + + def SetCurrentSceneCollection(self, name): + """ + Creates a new scene collection, switching to it in the process + Note: This will block until the collection has finished changing + + :param name: Name of the scene collection to switch to + :type name: str + """ + payload = {'sceneCollectionName': name} + response = self.base_client.req('SetCurrentSceneCollection', payload) + return response + + def CreateSceneCollection(self, name): + """ + Creates a new scene collection, switching to it in the process. + Note: This will block until the collection has finished changing. + + :param name: Name for the new scene collection + :type name: str + """ + payload = {'sceneCollectionName': name} + response = self.base_client.req('CreateSceneCollection', payload) + return response + + def GetProfileList(self): + """ + Gets a list of all profiles + + :return: profiles (List of all profiles) + :rtype: list[str] + """ + response = self.base_client.req('GetProfileList') + return response + + def SetCurrentProfie(self, name): + """ + Switches to a profile + + :param name: Name of the profile to switch to + :type name: str + """ + payload = {'profileName': name} + response = self.base_client.req('SetCurrentProfile', payload) + return response + + def CreateProfle(self, name): + """ + Creates a new profile, switching to it in the process + + :param name: Name for the new profile + :type name: str + """ + payload = {'profileName': name} + response = self.base_client.req('CreateProfile', payload) + return response + + def RemoveProfle(self, name): + """ + Removes a profile. If the current profile is chosen, + it will change to a different profile first. + + :param name: Name of the profile to remove + :type name: str + """ + payload = {'profileName': name} + response = self.base_client.req('RemoveProfile', payload) + return response + + def GetProfileParameter(self, category, name): + """ + Gets a parameter from the current profile's configuration.. + + :param category: Category of the parameter to get + :type category: str + :param name: Name of the parameter to get + :type name: str + + :return: Value and default value for the parameter + :rtype: str + """ + payload = { + 'parameterCategory': category, + 'parameterName': name + } + response = self.base_client.req('GetProfileParameter', payload) + return response + + def SetProfileParameter(self, category, name, value): + """ + Gets a parameter from the current profile's configuration.. + + :param category: Category of the parameter to set + :type category: str + :param name: Name of the parameter to set + :type name: str + :param value: Value of the parameter to set. Use null to delete + :type value: str + + :return: Value and default value for the parameter + :rtype: str + """ + payload = { + 'parameterCategory': category, + 'parameterName': name, + 'parameterValue': value + } + response = self.base_client.req('SetProfileParameter', payload) + return response + + def GetVideoSettings(self): + """ + Gets the current video settings. + Note: To get the true FPS value, divide the FPS numerator by the FPS denominator. + Example: 60000/1001 + + Response Fields + 'fpsNumerator' Number Numerator of the fractional FPS value + 'fpsDenominator' Number Denominator of the fractional FPS value + 'baseWidth' Number Width of the base (canvas) resolution in pixels + 'baseHeight' Number Height of the base (canvas) resolution in pixels + 'outputWidth' Number Width of the output resolution in pixels + 'outputHeight' Number Height of the output resolution in pixels + """ + response = self.base_client.req('GetVideoSettings') + return response + + def SetVideoSettings(self, numerator, denominator, base_width, base_height, out_width, out_height): + """ + Sets the current video settings. + Note: Fields must be specified in pairs. + For example, you cannot set only baseWidth without needing to specify baseHeight. + + :param numerator: Numerator of the fractional FPS value >=1 + :type numerator: int + :param denominator: Denominator of the fractional FPS value >=1 + :type denominator: int + :param base_width: Width of the base (canvas) resolution in pixels (>= 1, <= 4096) + :type base_width: int + :param base_height: Height of the base (canvas) resolution in pixels (>= 1, <= 4096) + :type base_height: int + :param out_width: Width of the output resolution in pixels (>= 1, <= 4096) + :type out_width: int + :param out_height: Height of the output resolution in pixels (>= 1, <= 4096) + :type out_height: int + """ + payload = { + 'fpsNumerator': numerator, + 'fpsDenominator': denominator, + 'baseWidth': base_width, + 'baseHeight': base_height, + 'outputWidth': out_width, + 'outputHeight': out_height + } + response = self.base_client.req('SetVideoSettings', payload) + return response + + def GetStreamServiceSettings(self): + """ + Gets the current stream service settings (stream destination). + + Response Fields + streamServiceType String Stream service type, like rtmp_custom or rtmp_common + streamServiceSettings Object Stream service settings + """ + response = self.base_client.req('GetStreamServiceSettings') + return response + + def SetStreamServiceSettings(self, ss_type, ss_settings): + """ + Sets the current stream service settings (stream destination). + Note: Simple RTMP settings can be set with type rtmp_custom + and the settings fields server and key. + + :param ss_type: Type of stream service to apply. Example: rtmp_common or rtmp_custom + :type ss_type: string + :param ss_setting: Settings to apply to the service + :type ss_setting: dict + """ + payload = { + 'streamServiceType': ss_type, + 'streamServiceSettings': ss_settings, + } + response = self.base_client.req('SetStreamServiceSettings', payload) + return response + + def GetSourceActive(self, name): + """ + Gets the active and show state of a source + + :param name: Name of the source to get the active state of + :type name: str + + Response Fields + videoActive bool Whether the source is showing in Program + videoShowing bool Whether the source is showing in the UI (Preview, Projection, Program) + """ + payload = {'sourceName': name} + response = self.base_client.req('GetSourceActive', payload) + return response + + def GetSourceScreenshot(self, name, img_format, width, height, quality): + """ + Gets a Base64-encoded screenshot of a source. + The imageWidth and imageHeight parameters are + treated as "scale to inner", meaning the smallest ratio + will be used and the aspect ratio of the original resolution is kept. + If imageWidth and imageHeight are not specified, the compressed image + will use the full resolution of the source. + + :param name: Name of the source to take a screenshot of + :type name: str + :param format: Image compression format to use. Use GetVersion to get compatible image formats + :type format: str + :param width: Width to scale the screenshot to (>= 8, <= 4096) + :type width: int + :param height: Height to scale the screenshot to (>= 8, <= 4096) + :type height: int + :param quality: Compression quality to use. 0 for high compression, 100 for uncompressed. -1 to use "default" + :type quality: int + + Response Fields + 'imageData' String Base64-encoded screenshot + """ + payload = { + 'sourceName': name, + 'imageFormat': img_format, + 'imageWidth': width, + 'imageHeight': height, + 'imageCompressionQuality': quality + } + response = self.base_client.req('GetSourceScreenshot', payload) + return response + + def SaveSourceScreenshot(self, name, img_format, file_path, width, height, quality): + """ + Saves a Base64-encoded screenshot of a source. + The imageWidth and imageHeight parameters are + treated as "scale to inner", meaning the smallest ratio + will be used and the aspect ratio of the original resolution is kept. + If imageWidth and imageHeight are not specified, the compressed image + will use the full resolution of the source. + + :param name: Name of the source to take a screenshot of + :type name: str + :param format: Image compression format to use. Use GetVersion to get compatible image formats + :type format: str + :param file_path: Path to save the screenshot file to. Eg. C:\\Users\\user\\Desktop\\screenshot.png + :type file_path: str + :param width: Width to scale the screenshot to (>= 8, <= 4096) + :type width: int + :param height: Height to scale the screenshot to (>= 8, <= 4096) + :type height: int + :param quality: Compression quality to use. 0 for high compression, 100 for uncompressed. -1 to use "default" + :type quality: int + + Response Fields + 'imageData' String Base64-encoded screenshot + """ + payload = { + 'sourceName': name, + 'imageFormat': img_format, + 'imageFilePath': file_path, + 'imageWidth': width, + 'imageHeight': height, + 'imageCompressionQuality': quality + } + response = self.base_client.req('SaveSourceScreenshot', payload) + return response + + def GetSceneList(self): + """ + Gets a list of all scenes in OBS. + + Response Fields + 'currentProgramSceneName' String Current program scene + 'currentPreviewSceneName' String Current preview scene. null if not in studio mode + 'scenes' List List of scenes + """ + response = self.base_client.req('GetSceneList') + return response + + def GetGroupList(self): + """ + Gets a list of all groups in OBS. + Groups in OBS are actually scenes, + but renamed and modified. In obs-websocket, + we treat them as scenes where we can.. + + Response Fields + groups List List of group names + """ + response = self.base_client.req('GetSceneList') + return response + + def GetCurrentProgramScene(self): + """ + Gets the current program scene + + Response Fields + 'currentProgramSceneName' String Current program scene + """ + response = self.base_client.req('GetCurrentProgramScene') + return response + + def SetCurrentProgramScene(self, name): + """ + Sets the current program scene + + :param name: Scene to set as the current program scene + :type name: str + """ + payload = {'sceneName': name} + response = self.base_client.req('SetCurrentProgramScene', payload) + return response + + def GetCurrentPreviewScene(self): + """ + Gets the current preview scene + + Response Fields + 'currentPreviewSceneName' String Current preview scene + """ + response = self.base_client.req('GetCurrentPreviewScene') + return response + + def SetCurrentPreviewScene(self, name): + """ + Sets the current program scene + + :param name: Scene to set as the current preview scene + :type name: str + """ + payload = {'sceneName': name} + response = self.base_client.req('SetCurrentPreviewScene', payload) + return response + + def CreateScene(self, name): + """ + Creates a new scene in OBS. + + :param name: Name for the new scene + :type name: str + """ + payload = {'sceneName': name } + response = self.base_client.req('CreateScene', payload) + return response + + def RemoveScene(self, name): + """ + Removes a scene from OBS + + :param name: Name of the scene to remove + :type name: str + """ + payload = {'sceneName': name } + response = self.base_client.req('RemoveScene', payload) + return response + + def SetSceneName(self, old_name, new_name): + """ + Sets the name of a scene (rename). + + :param old_name: Name of the scene to be renamed + :type old_name: str + :param new_name: New name for the scene + :type new_name: str + """ + payload = { + 'sceneName': old_name, + 'newSceneName': new_name + } + response = self.base_client.req('SetSceneName', payload) + return response + + def GetSceneSceneTransitionOverride(self, name): + """ + Gets the scene transition overridden for a scene. + + :param name: Name of the scene + :type name: str + + Response Fields + transitionName String Name of the overridden scene transition, else null + transitionDuration Number Duration of the overridden scene transition, else null + """ + payload = {'sceneName': name} + response = self.base_client.req('GetSceneSceneTransitionOverride', payload) + return response + + def SetSceneSceneTransitionOverride(self, scene_name, tr_name, tr_duration): + """ + Gets the scene transition overridden for a scene. + + :param scene_name: Name of the scene + :type scene_name: str + :param tr_name: Name of the scene transition to use as override. Specify null to remove + :type tr_name: str + :param tr_duration: Duration to use for any overridden transition. Specify null to remove (>= 50, <= 20000) + :type tr_duration: int + """ + payload = { + 'sceneName': scene_name, + 'transitionName': tr_name, + 'transitionDuration': tr_duration + } + response = self.base_client.req('SetSceneSceneTransitionOverride', payload) + return response + + def GetInputList(self, kind): + """ + Gets a list of all inputs in OBS. + + :param kind: Restrict the list to only inputs of the specified kind + :type kind: str + + Response Fields + inputs list List of inputs + """ + payload = {'inputKind': kind} + response = self.base_client.req('GetInputList', payload) + return response + + def GetInputKindList(self, unversioned): + """ + Gets a list of all available input kinds in OBS. + + :param unversioned: True == Return all kinds as unversioned, False == Return with version suffixes (if available) + :type unversioned: bool + + Response Fields + inputKinds list List of input kinds + """ + payload = {'unversioned': unversioned} + response = self.base_client.req('GetInputKindList', payload) + return response + + def GetSpecialInputs(self): + """ + Gets the name of all special inputs + + Response Fields + desktop1 String Name of the Desktop Audio input + desktop2 String Name of the Desktop Audio 2 input + mic1 String Name of the Mic/Auxiliary Audio input + mic2 String Name of the Mic/Auxiliary Audio 2 input + mic3 String Name of the Mic/Auxiliary Audio 3 input + mic4 String Name of the Mic/Auxiliary Audio 4 input + """ + response = self.base_client.req('GetSpecialInputs') + return response + + def CreateInput(self, sceneName, inputName, inputKind, inputSettings, sceneItemEnabled): + """ + Creates a new input, adding it as a scene item to the specified scene. + + :param sceneName: Name of the scene to add the input to as a scene item + :type sceneName: str + :param inputName Name of the new input to created + :type inputName: str + :param inputKind: The kind of input to be created + :type inputKind: str + :param inputSettings: Settings object to initialize the input with + :type inputSettings: object + :param sceneItemEnabled: Whether to set the created scene item to enabled or disabled + :type sceneItemEnabled: bool + + Response Fields + sceneItemId Number ID of the newly created scene item + """ + payload = { + 'sceneName': sceneName, + 'inputName': inputName, + 'inputKind': inputKind, + 'inputSettings': inputSettings, + 'sceneItemEnabled': sceneItemEnabled + } + response = self.base_client.req('CreateInput', payload) + return response + + def RemoveInput(self, name): + """ + Removes an existing input + + :param name: Name of the input to remove + :type name: str + """ + payload = {'inputName': name} + response = self.base_client.req('RemoveInput', payload) + return response + + def SetInputName(self, old_name, new_name): + """ + Sets the name of an input (rename). + + :param old_name: Current input name + :type old_name: str + :param new_name: New name for the input + :type new_name: str + """ + payload = { + 'inputName': old_name, + 'newInputName': new_name + } + response = self.base_client.req('SetInputName', payload) + return response + + def GetInputDefaultSettings(self, kind): + """ + Gets the default settings for an input kind. + + :param kind: Input kind to get the default settings for + :type kind: str + + Response Fields + defaultInputSettings object Object of default settings for the input kind + """ + payload = {'inputKind': kind} + response = self.base_client.req('GetInputDefaultSettings', payload) + return response + + def GetInputSettings(self, name): + """ + Gets the settings of an input. + Note: Does not include defaults. To create the entire settings object, + overlay inputSettings over the defaultInputSettings provided by GetInputDefaultSettings. + + :param name: Input kind to get the default settings for + :type name: str + + Response Fields + inputSettings object Object of settings for the input + inputKind String The kind of the input + """ + payload = {'inputName': name} + response = self.base_client.req('GetInputSettings', payload) + return response + + def SetInputSettings(self, name, settings, overlay): + """ + Sets the settings of an input. + + :param name: Name of the input to set the settings of + :type name: str + :param settings: Object of settings to apply + :type settings: dict + :param overlay: True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. + :type overlay: bool + + """ + payload = { + 'inputName': name, + 'inputSettings': settings, + 'overlay': overlay + } + response = self.base_client.req('SetInputSettings', payload) + return response + + def GetInputMute(self, name): + """ + Gets the audio mute state of an input + + :param name: Name of input to get the mute state of + :type name: str + + Response Fields + inputMuted Boolean Whether the input is muted + """ + payload = {'inputName': name} + response = self.base_client.req('GetInputMute', payload) + return response + + def SetInputMute(self, name, muted): + """ + Sets the audio mute state of an input. + + :param name: Name of the input to set the mute state of + :type name: str + :param muted: Whether to mute the input or not + :type muted: bool + """ + payload = { + 'inputName': name, + 'inputMuted': muted + } + response = self.base_client.req('SetInputMute', payload) + return response + + def ToggleInputMute(self, name): + """ + Toggles the audio mute state of an input. + + :param name: Name of the input to toggle the mute state of + :type name: str + + Response Fields + inputMuted Boolean Whether the input has been muted or unmuted + """ + payload = {'inputName': name} + response = self.base_client.req('ToggleInputMute', payload) + return response + + def GetInputVolume(self, name): + """ + Gets the current volume setting of an input. + + :param name: Name of the input to get the volume of + :type name: str + + Response Fields + inputVolumeMul Number Volume setting in mul + inputVolumeDb Number Volume setting in dB + """ + payload = {'inputName': name} + response = self.base_client.req('GetInputVolume', payload) + return response + + def SetInputVolume(self, name, vol_mul=None, vol_db=None): + """ + Sets the volume setting of an input. + + :param name: Name of the input to set the volume of + :type name: str + :param vol_mul: Volume setting in mul (>= 0, <= 20) + :type vol_mul: int + :param vol_db: Volume setting in dB (>= -100, <= 26) + :type vol_db: int + """ + payload = { + 'inputName': name, + 'inputVolumeMul': vol_mul, + 'inputVolumeDb': vol_db + } + response = self.base_client.req('SetInputVolume', payload) + return response + + def GetInputAudioBalance(self, name): + """ + Gets the audio balance of an input. + + :param name: Name of the input to get the audio balance of + :type name: str + + Response Fields + inputAudioBalance Number Audio balance value from 0.0-1.0 + """ + payload = {'inputName': name} + response = self.base_client.req('GetInputAudioBalance', payload) + return response + + def SetInputAudioBalance(self, name, balance): + """ + Sets the audio balance of an input. + + :param name: Name of the input to get the audio balance of + :type name: str + :param balance: New audio balance value (>= 0.0, <= 1.0) + :type balance: int + """ + payload = { + 'inputName': name, + 'inputAudioBalance': balance + } + response = self.base_client.req('SetInputAudioBalance', payload) + return response + + def GetInputAudioOffset(self, name): + """ + Gets the audio sync offset of an input. + + :param name: Name of the input to get the audio sync offset of + :type name: str + + Response Fields + inputAudioSyncOffset Number Audio sync offset in milliseconds + """ + payload = {'inputName': name} + response = self.base_client.req('GetInputAudioOffset', payload) + return response + + def SetInputAudioSyncOffset(self, name, offset): + """ + Sets the audio sync offset of an input. + + :param name: Name of the input to set the audio sync offset of + :type name: str + :param offset: New audio sync offset in milliseconds (>= -950, <= 20000) + :type offset: int + """ + payload = { + 'inputName': name, + 'inputAudioSyncOffset': offset + } + response = self.base_client.req('SetInputAudioSyncOffset', payload) + return response + + def GetInputAudioMonitorType(self, name): + """ + Gets the audio monitor type of an input. + + The available audio monitor types are: + + OBS_MONITORING_TYPE_NONE + + OBS_MONITORING_TYPE_MONITOR_ONLY + + OBS_MONITORING_TYPE_MONITOR_AND_OUTPUT + + + :param name: Name of the input to get the audio monitor type of + :type name: str + + Response Fields + monitorType String Audio monitor type + """ + payload = {'inputName': name} + response = self.base_client.req('GetInputAudioMonitorType', payload) + return response + + def SetInputAudioMonitorType(self, name, mon_type): + """ + Sets the audio monitor type of an input. + + :param name: Name of the input to set the audio monitor type of + :type name: str + :param mon_type: Audio monitor type + :type mon_type: int + """ + payload = { + 'inputName': name, + 'monitorType': mon_type + } + response = self.base_client.req('SetInputAudioMonitorType', payload) + return response + + def GetInputAudioTracks(self, name): + """ + Gets the enable state of all audio tracks of an input. + + :param name: Name of the input + :type name: str + + Response Fields + inputAudioTracks Object Object of audio tracks and associated enable states + """ + payload = {'inputName': name} + response = self.base_client.req('GetInputAudioTracks', payload) + return response + + def SetInputAudioTracks(self, name, track): + """ + Sets the audio monitor type of an input. + + :param name: Name of the input + :type name: str + :param track: Track settings to apply + :type track: int + """ + payload = { + 'inputName': name, + 'inputAudioTracks': track + } + response = self.base_client.req('SetInputAudioTracks', payload) + return response + + def GetInputPropertiesListPropertyItems(self, input_name, prop_name): + """ + Gets the items of a list property from an input's properties. + Note: Use this in cases where an input provides a dynamic, + selectable list of items. For example, display capture, + where it provides a list of available displays. + + :param input_name: Name of the input + :type input_name: str + :param prop_name: Name of the list property to get the items of + :type prop_name: str + + Response Field + propertyItems List Array of items in the list property + """ + payload = { + 'inputName': input_name, + 'propertyName': prop_name + } + response = self.base_client.req('GetInputPropertiesListPropertyItems', payload) + return response + + def PressInputPropertiesButton(self, input_name, prop_name): + """ + Presses a button in the properties of an input. + Note: Use this in cases where there is a button + in the properties of an input that cannot be accessed in any other way. + For example, browser sources, where there is a refresh button. + + :param input_name: Name of the input + :type input_name: str + :param prop_name: Name of the button property to press + :type prop_name: str + """ + payload = { + 'inputName': input_name, + 'propertyName': prop_name + } + response = self.base_client.req('PressInputPropertiesButton', payload) + return response + + def GetTransitionKindList(self): + """ + Gets an array of all available transition kinds. + Similar to GetInputKindList + + Response Fields + transitionKinds List List of transition kinds + """ + response = self.base_client.req('GetTransitionKindList') + return response + + def GetSceneTransitionList(self): + """ + Gets an array of all scene transitions in OBS. + + Response Fields + currentSceneTransitionName String Name of the current scene transition. Can be null + currentSceneTransitionKind String Kind of the current scene transition. Can be null + transitions List List of transitions + """ + response = self.base_client.req('GetSceneTransitionList') + return response + + def GetCurrentSceneTransition(self): + """ + Gets an array of all scene transitions in OBS. + + Response Fields + transitionName String Name of the transition + transitionKind String Kind of the transition + transitionFixed Boolean Whether the transition uses a fixed (unconfigurable) duration + transitionDuration Number Configured transition duration in milliseconds. null if transition is fixed + transitionConfigurable Boolean Whether the transition supports being configured + transitionSettings Object Object of settings for the transition. null if transition is not configurable + """ + response = self.base_client.req('GetCurrentSceneTransition') + return response + + def SetCurrentSceneTransition(self, name): + """ + Sets the current scene transition. + Small note: While the namespace of scene transitions is generally unique, + that uniqueness is not a guarantee as it is with other resources like inputs. + + :param name: Name of the transition to make active + :type name: str + """ + payload = {'transitionName': name} + response = self.base_client.req('SetCurrentSceneTransition', payload) + return response + + def SetCurrentSceneTransitionDuration(self, duration): + """ + Sets the duration of the current scene transition, if it is not fixed. + + :param duration: Duration in milliseconds (>= 50, <= 20000) + :type duration: str + """ + payload = {'transitionDuration': duration} + response = self.base_client.req('SetCurrentSceneTransitionDuration', payload) + return response + + def SetCurrentSceneTransitionSettings(self, settings, overlay=None): + """ + Sets the settings of the current scene transition. + + :param settings: Settings object to apply to the transition. Can be {} + :type settings: dict + :param overlay: Whether to overlay over the current settings or replace them + :type overlay: bool + """ + payload = { + 'transitionSettings': settings, + 'overlay': overlay + } + response = self.base_client.req('SetCurrentSceneTransitionSettings', payload) + return response + + def GetCurrentSceneTransitionCursor(self): + """ + Gets the cursor position of the current scene transition. + Note: transitionCursor will return 1.0 when the transition is inactive. + + Response Fields + :param transitionCursor: Cursor position, between 0.0 and 1.0 + :type transitionCursor: float + """ + response = self.base_client.req('GetCurrentSceneTransitionCursor') + return response + + def TriggerStudioModeTransition(self): + """ + Triggers the current scene transition. + Same functionality as the Transition button in studio mode. + Note: Studio mode should be active. if not throws an + RequestStatus::StudioModeNotActive (506) in response + """ + response = self.base_client.req('TriggerStudioModeTransition') + return response + + def SetTBarPosition(self, pos, release=None): + """ + Sets the position of the TBar. + Very important note: This will be deprecated + and replaced in a future version of obs-websocket. + + :param pos: New position (>= 0.0, <= 1.0) + :type pos: float + :param release: Whether to release the TBar. Only set false if you know that you will be sending another position update + :type release: bool + """ + payload = { + 'position': pos, + 'release': release + } + response = self.base_client.req('SetTBarPosition', payload) + return response + + def GetSourceFilterList(self, name): + """ + Gets a list of all of a source's filters. + + :param name: Name of the source + :type name: str + + Response Fields + :param filters: List of filters + :type filters: list[dict] + """ + payload = {'sourceName': name} + response = self.base_client.req('GetSourceFilterList', payload) + return response + + def GetSourceFilterDefaultSettings(self, kind): + """ + Gets the default settings for a filter kind. + + :param kind: Filter kind to get the default settings for + :type kind: str + + Response Fields + :param defaultFilterSettings: Dictionary of default settings for the filter kind + :type defaultFilterSettings: dict + """ + payload = {'filterKind': kind} + response = self.base_client.req('GetSourceFilterDefaultSettings', payload) + return response + + def CreateSourceFilter(self, source_name, filter_name, filter_kind, filter_settings=None): + """ + Gets the default settings for a filter kind. + + :param source_name: Name of the source to add the filter to + :type source_name: str + :param filter_name: Name of the new filter to be created + :type filter_name: str + :param filter_kind: The kind of filter to be created + :type filter_kind: str + :param filter_settings: Settings object to initialize the filter with + :type filter_settings: dict + """ + payload = { + 'sourceName': source_name, + 'filterName': filter_name, + 'filterKind': filter_kind, + 'filterSettings': filter_settings + } + response = self.base_client.req('CreateSourceFilter', payload) + return response + + def RemoveSourceFilter(self, source_name, filter_name): + """ + Gets the default settings for a filter kind. + + :param source_name: Name of the source the filter is on + :type source_name: str + :param filter_name: Name of the filter to remove + :type filter_name: str + """ + payload = { + 'sourceName': source_name, + 'filterName': filter_name, + } + response = self.base_client.req('RemoveSourceFilter', payload) + return response + + def SetSourceFilterName(self, source_name, old_filter_name, new_filter_name): + """ + Sets the name of a source filter (rename). + + :param source_name: Name of the source the filter is on + :type source_name: str + :param old_filter_name: Current name of the filter + :type old_filter_name: str + :param new_filter_name: New name for the filter + :type new_filter_name: str + + """ + payload = { + 'sourceName': source_name, + 'filterName': old_filter_name, + 'newFilterName': new_filter_name, + } + response = self.base_client.req('SetSourceFilterName', payload) + return response + + def GetSourceFilter(self, source_name, filter_name): + """ + Gets the info for a specific source filter. + + :param source_name: Name of the source + :type source_name: str + :param filter_name: Name of the filter + :type filter_name: str + + Response Fields + :param filterEnabled: Whether the filter is enabled + :type filterEnabled: bool + :param filterIndex: Index of the filter in the list, beginning at 0 + :type filterIndex: int + :param filterKind: The kind of filter + :type filterKind: str + :param filterSettings: Settings object associated with the filter + :type filterSettings: dict + """ + payload = { + 'sourceName': source_name, + 'filterName': filter_name + } + response = self.base_client.req('GetSourceFilter', payload) + return response + + def SetSourceFilterIndex(self, source_name, filter_name, filter_index): + """ + Gets the info for a specific source filter. + + :param source_name: Name of the source the filter is on + :type source_name: str + :param filter_name: Name of the filter + :type filter_name: str + :param filterIndex: New index position of the filter (>= 0) + :type filterIndex: int + """ + payload = { + 'sourceName': source_name, + 'filterName': filter_name, + 'filterIndex': filter_index + } + response = self.base_client.req('SetSourceFilterIndex', payload) + return response + + def SetSourceFilterSettings(self, source_name, filter_name, settings, overlay=None): + """ + Gets the info for a specific source filter. + + :param source_name: Name of the source the filter is on + :type source_name: str + :param filter_name: Name of the filter to set the settings of + :type filter_name: str + :param settings: Dictionary of settings to apply + :type settings: dict + :param overlay: True == apply the settings on top of existing ones, False == reset the input to its defaults, then apply settings. + :type overlay: bool + """ + payload = { + 'sourceName': source_name, + 'filterName': filter_name, + 'filterSettings': settings, + 'overlay': overlay + } + response = self.base_client.req('SetSourceFilterSettings', payload) + return response + + def SetSourceFilterEnabled(self, source_name, filter_name, enabled): + """ + Gets the info for a specific source filter. + + :param source_name: Name of the source the filter is on + :type source_name: str + :param filter_name: Name of the filter + :type filter_name: str + :param enabled: New enable state of the filter + :type enabled: bool + """ + payload = { + 'sourceName': source_name, + 'filterName': filter_name, + 'filterEnabled': enabled + } + response = self.base_client.req('SetSourceFilterEnabled', payload) + return response + + def GetSceneItemList(self, name): + """ + Gets a list of all scene items in a scene. + + :param name: Name of the scene to get the items of + :type name: str + + Response Fields + :param sceneItems: List of scene items in the scene + :type sceneItems: list[dict] + """ + payload = {'sceneName': name} + response = self.base_client.req('GetSceneItemList', payload) + return response + + def GetGroupItemList(self, name): + """ + Gets a list of all scene items in a scene. + + :param name: Name of the group to get the items of + :type name: str + + Response Fields + :param sceneItems: Array of scene items in the group + :type sceneItems: list[dict] + """ + payload = {'sceneName': name} + response = self.base_client.req('GetGroupItemList', payload) + return response + + def GetSceneItemId(self, scene_name, source_name, offset=None): + """ + Searches a scene for a source, and returns its id. + + :param scene_name: Name of the scene or group to search in + :type scene_name: str + :param source_name: Name of the source to find + :type source_name: str + :param offset: Number of matches to skip during search. >= 0 means first forward. -1 means last (top) item (>= -1) + :type offset: int + + Response Fields + :param sceneItemId: Numeric ID of the scene item + :type sceneItemId: int + """ + payload = { + 'sceneName': scene_name, + 'sourceName': source_name, + 'searchOffset': offset + } + response = self.base_client.req('GetSceneItemId', payload) + return response + + def CreateSceneItem(self, scene_name, source_name, enabled=None): + """ + Creates a new scene item using a source. + Scenes only + + :param scene_name: Name of the scene to create the new item in + :type scene_name: str + :param source_name: Name of the source to add to the scene + :type source_name: str + :param enabled: Enable state to apply to the scene item on creation + :type enabled: bool + + Response Fields + :param sceneItemId: Numeric ID of the scene item + :type sceneItemId: int + """ + payload = { + 'sceneName': scene_name, + 'sourceName': source_name, + 'sceneItemEnabled': enabled + } + response = self.base_client.req('CreateSceneItem', payload) + return response + + def RemoveSceneItem(self, scene_name, item_id): + """ + Removes a scene item from a scene. + Scenes only + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item + :type item_id: int + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + } + response = self.base_client.req('RemoveSceneItem', payload) + return response + + def DuplicateSceneItem(self, scene_name, item_id, dest_scene_name=None): + """ + Duplicates a scene item, copying all transform and crop info. + Scenes only + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item (>= 0) + :type item_id: int + :param dest_scene_name: Name of the scene to create the duplicated item in + :type dest_scene_name: str + + Response Fields + :param sceneItemId: Numeric ID of the scene item + :type sceneItemId: int + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + 'destinationSceneName': dest_scene_name + } + response = self.base_client.req('DuplicateSceneItem', payload) + return response + + def GetSceneItemTransform(self, scene_name, item_id): + """ + Gets the transform and crop info of a scene item. + Scenes and Groups + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item (>= 0) + :type item_id: int + + Response Fields + :param sceneItemTransform: Dictionary containing scene item transform info + :type sceneItemTransform: dict + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + } + response = self.base_client.req('GetSceneItemTransform', payload) + return response + + def SetSceneItemTransform(self, scene_name, item_id, transform): + """ + Sets the transform and crop info of a scene item. + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item (>= 0) + :type item_id: int + :param transform: Dictionary containing scene item transform info to update + :type transform: dict + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + 'sceneItemTransform': transform + } + response = self.base_client.req('SetSceneItemTransform', payload) + return response + + def GetSceneItemEnabled(self, scene_name, item_id): + """ + Gets the enable state of a scene item. + Scenes and Groups + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item (>= 0) + :type item_id: int + + Response Fields + :param sceneItemEnabled: Whether the scene item is enabled. true for enabled, false for disabled + :type sceneItemEnabled: bool + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + } + response = self.base_client.req('GetSceneItemEnabled', payload) + return response + + def SetSceneItemEnabled(self, scene_name, item_id, enabled): + """ + Sets the enable state of a scene item. + Scenes and Groups' + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item (>= 0) + :type item_id: int + :param enabled: New enable state of the scene item + :type enabled: bool + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + 'sceneItemEnabled': enabled + } + response = self.base_client.req('SetSceneItemEnabled', payload) + return response + + def GetSceneItemLocked(self, scene_name, item_id): + """ + Gets the lock state of a scene item. + Scenes and Groups + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item (>= 0) + :type item_id: int + + Response Fields + :param sceneItemLocked: Whether the scene item is locked. true for locked, false for unlocked + :type sceneItemLocked: bool + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + } + response = self.base_client.req('GetSceneItemLocked', payload) + return response + + def SetSceneItemLocked(self, scene_name, item_id, locked): + """ + Sets the lock state of a scene item. + Scenes and Groups + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item (>= 0) + :type item_id: int + :param locked: New lock state of the scene item + :type locked: bool + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + 'sceneItemLocked': locked + } + response = self.base_client.req('SetSceneItemLocked', payload) + return response + + def GetSceneItemIndex(self, scene_name, item_id): + """ + Gets the index position of a scene item in a scene. + An index of 0 is at the bottom of the source list in the UI. + Scenes and Groups + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item (>= 0) + :type item_id: int + + Response Fields + :param sceneItemIndex: Index position of the scene item + :type sceneItemIndex: int + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + } + response = self.base_client.req('GetSceneItemIndex', payload) + return response + + def SetSceneItemIndex(self, scene_name, item_id, item_index): + """ + Sets the index position of a scene item in a scene. + Scenes and Groups + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item (>= 0) + :type item_id: int + :param item_index: New index position of the scene item (>= 0) + :type item_index: int + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + 'sceneItemLocked': item_index + } + response = self.base_client.req('SetSceneItemIndex', payload) + return response + + def GetSceneItemBlendMode(self, scene_name, item_id): + """ + Gets the blend mode of a scene item. + Blend modes: + + OBS_BLEND_NORMAL + OBS_BLEND_ADDITIVE + OBS_BLEND_SUBTRACT + OBS_BLEND_SCREEN + OBS_BLEND_MULTIPLY + OBS_BLEND_LIGHTEN + OBS_BLEND_DARKEN + Scenes and Groups + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item (>= 0) + :type item_id: int + + Response Fields + :param sceneItemBlendMode: Current blend mode + :type sceneItemBlendMode: str + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + } + response = self.base_client.req('GetSceneItemBlendMode', payload) + return response + + def SetSceneItemBlendMode(self, scene_name, item_id, blend): + """ + Sets the blend mode of a scene item. + Scenes and Groups + + :param scene_name: Name of the scene the item is in + :type scene_name: str + :param item_id: Numeric ID of the scene item (>= 0) + :type item_id: int + :param blend: New blend mode + :type blend: str + """ + payload = { + 'sceneName': scene_name, + 'sceneItemId': item_id, + 'sceneItemBlendMode': blend + } + response = self.base_client.req('SetSceneItemBlendMode', payload) + return response + + def GetVirtualCamStatus(self): + """ + Gets the status of the virtualcam output. + + Response Fields + :param outputActive: Whether the output is active + :type outputActive: bool + """ + response = self.base_client.req('GetVirtualCamStatus') + return response + + def ToggleVirtualCam(self): + """ + Toggles the state of the virtualcam output. + + Response Fields + :param outputActive: Whether the output is active + :type outputActive: bool + """ + response = self.base_client.req('ToggleVirtualCam') + return response + + def StartVirtualCam(self): + """ + Starts the virtualcam output. + """ + response = self.base_client.req('StartVirtualCam') + return response + + def StopVirtualCam(self): + """ + Stops the virtualcam output. + """ + response = self.base_client.req('StopVirtualCam') + return response + + def GetReplayBufferStatus(self): + """ + Gets the status of the replay buffer output. + + Response Fields + :param outputActive: Whether the output is active + :type outputActive: bool + """ + response = self.base_client.req('GetReplayBufferStatus') + return response + + def ToggleReplayBuffer(self): + """ + Toggles the state of the replay buffer output. + + Response Fields + :param outputActive: Whether the output is active + :type outputActive: bool + """ + response = self.base_client.req('ToggleReplayBuffer') + return response + + def StartReplayBuffer(self): + """ + Starts the replay buffer output. + """ + response = self.base_client.req('StartReplayBuffer') + return response + + def StopReplayBuffer(self): + """ + Stops the replay buffer output. + """ + response = self.base_client.req('StopReplayBuffer') + return response + + def SaveReplayBuffer(self): + """ + Saves the contents of the replay buffer output. + """ + response = self.base_client.req('SaveReplayBuffer') + return response + + def GetLastReplayBufferReplay(self): + """ + Gets the filename of the last replay buffer save file. + + Response Fields + :param savedReplayPath: File Path + :type savedReplayPath: str + """ + response = self.base_client.req('GetLastReplayBufferReplay') + return response + + def GetStreamStatus(self): + """ + Gets the status of the stream output. + + Response Fields + :param outputActive: Whether the output is active + :type outputActive: bool + :param outputReconnecting: Whether the output is currently reconnecting + :type outputReconnecting: bool + :param outputTimecode: Current formatted timecode string for the output + :type outputTimecode: str + :param outputDuration: Current duration in milliseconds for the output + :type outputDuration: int + :param outputBytes: Number of bytes sent by the output + :type outputBytes: int + :param outputSkippedFrames: Number of frames skipped by the output's process + :type outputSkippedFrames: int + :param outputTotalFrames: Total number of frames delivered by the output's process + :type outputTotalFrames: int + """ + response = self.base_client.req('GetStreamStatus') + return response + + def ToggleStream(self): + """ + Toggles the status of the stream output. + + Response Fields + :param outputActive: New state of the stream output + :type outputActive: str + """ + response = self.base_client.req('ToggleStream') + return response + + def StartStream(self): + """ + Starts the stream output. + """ + response = self.base_client.req('StartStream') + return response + + def StopStream(self): + """ + Stops the stream output. + """ + response = self.base_client.req('StopStream') + return response + + def SendStreamCaption(self, caption): + """ + Sends CEA-608 caption text over the stream output. + + :param caption: Caption text + :type caption: str + """ + response = self.base_client.req('SendStreamCaption') + return response + + def GetRecordStatus(self): + """ + Gets the status of the record output. + + Response Fields + :param outputActive: Whether the output is active + :type outputActive: bool + :param ouputPaused: Whether the output is paused + :type ouputPaused: bool + :param outputTimecode: Current formatted timecode string for the output + :type outputTimecode: str + :param outputDuration: Current duration in milliseconds for the output + :type outputDuration: int + :param outputBytes: Number of bytes sent by the output + :type outputBytes: int + """ + response = self.base_client.req('GetRecordStatus') + return response + + def ToggleRecord(self): + """ + Toggles the status of the record output. + """ + response = self.base_client.req('ToggleRecord') + return response + + def StartRecord(self): + """ + Starts the record output. + """ + response = self.base_client.req('StartRecord') + return response + + def StopRecord(self): + """ + Stops the record output. + """ + response = self.base_client.req('StopRecord') + return response + + def ToggleRecordPause(self): + """ + Toggles pause on the record output. + """ + response = self.base_client.req('ToggleRecordPause') + return response + + def PauseRecord(self): + """ + Pauses the record output. + """ + response = self.base_client.req('PauseRecord') + return response + + def ResumeRecord(self): + """ + Resumes the record output. + """ + response = self.base_client.req('ResumeRecord') + return response + + def GetMediaInputStatus(self, name): + """ + Gets the status of a media input. + + Media States: + + OBS_MEDIA_STATE_NONE + + OBS_MEDIA_STATE_PLAYING + + OBS_MEDIA_STATE_OPENING + + OBS_MEDIA_STATE_BUFFERING + + OBS_MEDIA_STATE_PAUSED + + OBS_MEDIA_STATE_STOPPED + + OBS_MEDIA_STATE_ENDED + + OBS_MEDIA_STATE_ERROR + + :param name: Name of the media input + :type name: str + + Response Fields + :param mediaState: Name of the media input + :type mediaState: int + :param mediaDuration: Name of the media input + :type mediaDuration: int + :param mediaCursor: Name of the media input + :type mediaCursor: int + """ + payload = {'inputName': name} + response = self.base_client.req('GetMediaInputStatus', payload) + return response + + def SetMediaInputCursor(self, name, cursor): + """ + Sets the cursor position of a media input. + This request does not perform bounds checking of the cursor position. + + :param name: Name of the media input + :type name: str + :param cursor: New cursor position to set (>= 0) + :type cursor: int + """ + payload = { + 'inputName': name, + 'mediaCursor': cursor + } + response = self.base_client.req('SetMediaInputCursor', payload) + return response + + def OffsetMediaInputCursor(self, name, offset): + """ + Offsets the current cursor position of a media input by the specified value. + This request does not perform bounds checking of the cursor position. + + :param name: Name of the media input + :type name: str + :param offset: Value to offset the current cursor position by + :type offset: int + """ + payload = { + 'inputName': name, + 'mediaCursorOffset': offset + } + response = self.base_client.req('OffsetMediaInputCursor', payload) + return response + + def TriggerMediaInputAction(self, name, action): + """ + Triggers an action on a media input. + + :param name: Name of the media input + :type name: str + :param action: Identifier of the ObsMediaInputAction enum + :type action: str + """ + payload = { + 'inputName': name, + 'mediaAction': action + } + response = self.base_client.req('TriggerMediaInputAction', payload) + return response + + def GetStudioModeEnabled(self): + """ + Gets whether studio is enabled. + + Response Fields + :param studioModeEnabled: Whether studio mode is enabled + :type studioModeEnabled: bool + """ + response = self.base_client.req('GetStudioModeEnabled') + return response + + def SetStudioModeEnabled(self, enabled): + """ + Enables or disables studio mode + + :param enabled: True == Enabled, False == Disabled + :type enabled: bool + """ + payload = {'studioModeEnabled': enabled} + response = self.base_client.req('SetStudioModeEnabled', payload) + return response + + def OpenInputPropertiesDialog(self, name): + """ + Opens the properties dialog of an input. + + :param name: Name of the input to open the dialog of + :type name: str + """ + payload = {'inputName': name} + response = self.base_client.req('OpenInputPropertiesDialog', payload) + return response + + def OpenInputFiltersDialog(self, name): + """ + Opens the filters dialog of an input. + + :param name: Name of the input to open the dialog of + :type name: str + """ + payload = {'inputName': name} + response = self.base_client.req('OpenInputFiltersDialog', payload) + return response + + def OpenInputInteractDialog(self, name): + """ + Opens the filters dialog of an input. + + :param name: Name of the input to open the dialog of + :type name: str + """ + payload = {'inputName': name} + response = self.base_client.req('OpenInputInteractDialog', payload) + return response + + def GetMonitorList(self, name): + """ + Gets a list of connected monitors and information about them. + + Response Fields + :param monitors: a list of detected monitors with some information + :type monitors: list + """ + response = self.base_client.req('GetMonitorList') + return response \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..5176f3c --- /dev/null +++ b/setup.py @@ -0,0 +1,40 @@ +import pathlib +from setuptools import setup, find_packages + +HERE = pathlib.Path(__file__).parent + + +VERSION = '0.4' +PACKAGE_NAME = 'obsstudio_sdk' +AUTHOR = 'Adem Atikturk' +AUTHOR_EMAIL = 'aatikturk@gmail.com' +URL = 'https://github.com/aatikturk/obsstudio_sdk' +LICENSE = 'GNU General Public License v3.0' +DESCRIPTION = 'A Python SDK for OBS Studio WebSocket v5.0' + + +LONG_DESCRIPTION = (HERE / "README.md").read_text() +LONG_DESC_TYPE = "text/markdown" + +# Dependencies for the package +INSTALL_REQUIRES = [ + 'websocket-client' +] + +# Python version requirement +PYTHON_REQUIRES = '>=3' + +setup(name=PACKAGE_NAME, + version=VERSION, + description=DESCRIPTION, + long_description=LONG_DESCRIPTION, + long_description_content_type=LONG_DESC_TYPE, + author=AUTHOR, + license=LICENSE, + author_email=AUTHOR_EMAIL, + url=URL, + install_requires=INSTALL_REQUIRES, + python_requires=PYTHON_REQUIRES, + py_modules = ['baseclient', 'reqs'], + packages=['obsstudio_sdk'] + )