OpenTok

Documentation

data OpenTok

Represents an OpenTok project.

Get your project key and secret from https://tokbox.com/account/

Instances

Show OpenTok

Defined in OpenTok

Methods

showsPrec :: Int -> OpenTok -> ShowS

show :: OpenTok -> String

showList :: [OpenTok] -> ShowS

opentok :: APIKey -> APISecret -> OpenTok

Get an OpenTok project

ot = opentok "my_api_key" "my_api_secret"

createSession :: OpenTok -> SessionOptions -> IO (Either OTError Session)

Generate a new OpenTok Session

options = sessionOpts { mediaMode = Routed }
session <- createSession ot sessionOpts

generateToken :: OpenTok -> SessionId -> TokenOptions -> IO (Either OTError Token)

Generate a token.

let options = tokenOpts { connectionData = "name:tim" }
token <- generateToken ot options

type Token = String

An access token for an OpenTok Session

data TokenOptions

Instances

Show TokenOptions

Defined in OpenTok.Token

Methods

showsPrec :: Int -> TokenOptions -> ShowS

show :: TokenOptions -> String

showList :: [TokenOptions] -> ShowS

Generic TokenOptions

Defined in OpenTok.Token

Associated Types

type Rep TokenOptions :: * -> *

Methods

from :: TokenOptions -> Rep TokenOptions x

to :: Rep TokenOptions x -> TokenOptions

type Rep TokenOptions

Defined in OpenTok.Token

type Rep TokenOptions

tokenOpts :: TokenOptions

Default Token options

TokenOptions
  { _role                       = Publisher
  , _expireTime                 = Nothing
  , _connectionData             = Nothing
  , _initialLayoutClassList     = Nothing
}

startArchive :: OpenTok -> ArchiveOptions -> IO (Either OTError Archive)

Start recording an archive of an OpenTok session

startArchive ot archiveOpts { sessionId = "your_session_id" }

stopArchive :: OpenTok -> ArchiveId -> IO (Either OTError Archive)

Stop recording an archive of an OpenTok session

stopArchive ot archiveOpts { sessionId = "your_session_id" }