|
| 1 | +OpenTimelineIO-Java-bindings |
| 2 | +======= |
| 3 | +[](http://opentimeline.io) |
| 4 | +============== |
| 5 | + |
| 6 | +[](http://www.vfxplatform.com/) |
| 7 | + |
| 8 | +Main web site: http://opentimeline.io/ |
| 9 | + |
| 10 | +Documentation: |
| 11 | + |
| 12 | +Discussion group: https://lists.aswf.io/g/otio-discussion |
| 13 | + |
| 14 | +Slack channel: https://academysoftwarefdn.slack.com/messages/CMQ9J4BQC |
| 15 | +To join, create an account here first: https://slack.aswf.io/ |
| 16 | + |
| 17 | +PUBLIC BETA NOTICE |
| 18 | +------------------ |
| 19 | + |
| 20 | +OpenTimelineIO is currently in Public Beta. That means that it may be missing |
| 21 | +some essential features and there are large changes planned. During this phase |
| 22 | +we actively encourage you to provide feedback, requests, comments, and/or |
| 23 | +contributions. |
| 24 | + |
| 25 | +Overview |
| 26 | +-------- |
| 27 | + |
| 28 | +OpenTimelineIO is an interchange format and API for editorial cut information. |
| 29 | +OTIO is not a container format for media, rather it contains information about |
| 30 | +the order and length of cuts and references to external media. This repository |
| 31 | +contains the Java bindings built over the C++ core which you can find [here](https://github.com/PixarAnimationStudios/OpenTimelineIO). |
| 32 | + |
| 33 | +OTIO includes both a file format and an API for manipulating that format. |
| 34 | +It also implements a dependency-less library for dealing strictly with time, `opentime`. |
| 35 | + |
| 36 | +You can provide adapters for your video editing tool or pipeline as needed. |
| 37 | + |
| 38 | +Quick-Start |
| 39 | +----------- |
| 40 | + |
| 41 | +You can add OpenTimelineIO as a dependency to your gradle project as: |
| 42 | +``` |
| 43 | +<insert gradle dep> |
| 44 | +``` |
| 45 | + |
| 46 | +You can add OpenTimelineIO as a dependency to your maven project as: |
| 47 | +``` |
| 48 | +<insert maven dep> |
| 49 | +``` |
| 50 | + |
| 51 | + |
| 52 | +Building OpenTimelineIO-Java-Bindings |
| 53 | +------------------------ |
| 54 | + |
| 55 | +OpenTimelineIO-Java-Bindings have been built and tested on Ubuntu 18.04LTS, Windows 10 and macOS using [Gradle](https://gradle.org/install/) and [CMake](https://cmake.org/download/). |
| 56 | +After installing Gradle and CMake follw these steps: |
| 57 | + |
| 58 | +```console |
| 59 | +git clone --recurse-submodules https://github.com/OpenTimelineIO/OpenTimelineIO-Java-Bindings |
| 60 | + |
| 61 | +cd otio-java |
| 62 | + |
| 63 | +gradle build # this builds and runs all tests |
| 64 | +``` |
| 65 | + |
| 66 | +You can find the generated jar file in the `build/libs` directory. |
| 67 | + |
| 68 | +Examples |
| 69 | +-------- |
| 70 | + |
| 71 | +Looking through the unit tests is a great way to see what OTIO can do. |
| 72 | +See [here](https://github.com/OpenTimelineIO/OpenTimelineIO-Java-Bindings/tree/master/src/test/java/io/opentimeline). |
| 73 | + |
| 74 | +Developing |
| 75 | +---------- |
| 76 | + |
| 77 | +If you want to contribute to the project, please see: https://opentimelineio.readthedocs.io/en/latest/tutorials/contributing.html |
| 78 | + |
| 79 | +You can get the latest development version via: |
| 80 | + |
| 81 | +`git clone --recurse-submodules https://github.com/OpenTimelineIO/OpenTimelineIO-Java-Bindings.git` |
| 82 | + |
| 83 | +License |
| 84 | +------- |
| 85 | +OpenTimelineIO is open source software. Please see the [LICENSE](LICENSE) for details. |
| 86 | + |
| 87 | +Nothing in the license file or this project grants any right to use Pixar or any other contributor’s trade names, trademarks, service marks, or product names. |
| 88 | + |
| 89 | +Contact |
| 90 | +------- |
| 91 | + |
| 92 | +For more information, please visit http://opentimeline.io/ |
| 93 | +or https://github.com/PixarAnimationStudios/OpenTimelineIO |
| 94 | +or join our discussion forum: https://lists.aswf.io/g/otio-discussion |
0 commit comments