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)

Create 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 Role

Constructors

Subscriber

Publisher

Moderator

Instances

Data Role

Defined in OpenTok.Token

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Role -> c Role

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Role

toConstr :: Role -> Constr

dataTypeOf :: Role -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Role)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Role)

gmapT :: (forall b. Data b => b -> b) -> Role -> Role

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Role -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Role -> r

gmapQ :: (forall d. Data d => d -> u) -> Role -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Role -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Role -> m Role

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Role -> m Role

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Role -> m Role

Show Role

Defined in OpenTok.Token

Methods

showsPrec :: Int -> Role -> ShowS

show :: Role -> String

showList :: [Role] -> ShowS

data TokenOptions

Information on user roles and other options can be found at https://tokbox.com/developer/guides/create-token/

Constructors

TokenOptions

Fields

• _role :: Role
• _expireTime :: Maybe UTCTime
• _connectionData :: Maybe String
• _initialLayoutClassList :: Maybe [String]

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 = D1 (MetaData "TokenOptions" "OpenTok.Token" "opentok-0.0.5-IcL1zYCkr65C5B0v2oYVUO" False) (C1 (MetaCons "TokenOptions" PrefixI True) ((S1 (MetaSel (Just "_role") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Role) :*: S1 (MetaSel (Just "_expireTime") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UTCTime))) :*: (S1 (MetaSel (Just "_connectionData") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :*: S1 (MetaSel (Just "_initialLayoutClassList") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [String])))))

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 "your_session_id"

listArchives :: OpenTok -> ListArchiveOptions -> IO (Either OTError ArchiveCollection)

Get a list of all archives for a project or a single session

listArchives ot listArchiveOpts { _forSessionId = "some_session_id" }

deleteArchive :: OpenTok -> ArchiveId -> IO (Either OTError ArchiveId)

Delete an Archive

deleteArchive ot "some_archive_id"