Getting started

Setup

In order to use the opencastR package the hostname of your Opencast server, your username and password need to be set as environment variables. For this example I use the Legacy Opencast Testserver and the default credentials.

library(opencastR)

Sys.setenv(OPENCAST_HOST = "https://legacy.opencast.org")
Sys.setenv(OPENCAST_USERNAME = "admin")
Sys.setenv(OPENCAST_PASSWORD = "opencast")

First call

To check if everything is setup correctly the oc_api function can be used which returns the default api version and the server url.

oc_api()
#> $content
#> $content$version
#> [1] "v1.2.0"
#> 
#> $content$url
#> [1] "http://localhost:8080/api"
#> 
#> 
#> $url
#> [1] "https://legacy.opencast.org/api/"
#> 
#> $response
#> Response [https://legacy.opencast.org/api/]
#>   Date: 2020-03-19 11:47
#>   Status: 200
#>   Content-Type: application/json
#>   Size: 57 B
#> 
#> 
#> attr(,"class")
#> [1] "opencast_api"

The return of this functions shows that a list of the class opencast_api has been returned. This list contains three elements. The content, the url that was called and the full response. So access only the content we can do the following.

api_test <- oc_api()
api_test$content
#> $version
#> [1] "v1.2.0"
#> 
#> $url
#> [1] "http://localhost:8080/api"

Events

To showcase a more useful functions a list of events on the testserver can be retrieved.

events <- oc_list_events()
kable(events$content)