OpenTok.Session

Documentation

data ArchiveMode

Manual, as it implies, requires archives to be manually started and stopped. Always means that archives will automatically be created.

Constructors

Manual

Always

Instances

Data ArchiveMode

Defined in OpenTok.Session

Methods

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

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

toConstr :: ArchiveMode -> Constr

dataTypeOf :: ArchiveMode -> DataType

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

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

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

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

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

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

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

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

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

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

Show ArchiveMode

Defined in OpenTok.Session

Methods

showsPrec :: Int -> ArchiveMode -> ShowS

show :: ArchiveMode -> String

showList :: [ArchiveMode] -> ShowS

Generic ArchiveMode

Defined in OpenTok.Session

Associated Types

type Rep ArchiveMode :: * -> *

Methods

from :: ArchiveMode -> Rep ArchiveMode x

to :: Rep ArchiveMode x -> ArchiveMode

ToJSON ArchiveMode

Defined in OpenTok.Session

Methods

toJSON :: ArchiveMode -> Value

toEncoding :: ArchiveMode -> Encoding

toJSONList :: [ArchiveMode] -> Value

toEncodingList :: [ArchiveMode] -> Encoding

FromJSON ArchiveMode

Defined in OpenTok.Session

Methods

parseJSON :: Value -> Parser ArchiveMode

parseJSONList :: Value -> Parser [ArchiveMode]

type Rep ArchiveMode

Defined in OpenTok.Session

type Rep ArchiveMode = D1 (MetaData "ArchiveMode" "OpenTok.Session" "opentok-0.0.4-D6yY9RxUQIKFjtnnziRYka" False) (C1 (MetaCons "Manual" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Always" PrefixI False) (U1 :: * -> *))

data MediaMode

Relayed sessions will attempt to use peer-to-peer (p2p) connections.

Routed sessions will use the OpenTok Media Router

Constructors

Relayed

Routed

Instances

Data MediaMode

Defined in OpenTok.Session

Methods

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

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

toConstr :: MediaMode -> Constr

dataTypeOf :: MediaMode -> DataType

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

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

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

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

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

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

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

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

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

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

Show MediaMode

Defined in OpenTok.Session

Methods

showsPrec :: Int -> MediaMode -> ShowS

show :: MediaMode -> String

showList :: [MediaMode] -> ShowS

Generic MediaMode

Defined in OpenTok.Session

Associated Types

type Rep MediaMode :: * -> *

Methods

from :: MediaMode -> Rep MediaMode x

to :: Rep MediaMode x -> MediaMode

ToJSON MediaMode

Defined in OpenTok.Session

Methods

toJSON :: MediaMode -> Value

toEncoding :: MediaMode -> Encoding

toJSONList :: [MediaMode] -> Value

toEncodingList :: [MediaMode] -> Encoding

FromJSON MediaMode

Defined in OpenTok.Session

Methods

parseJSON :: Value -> Parser MediaMode

parseJSONList :: Value -> Parser [MediaMode]

type Rep MediaMode

Defined in OpenTok.Session

type Rep MediaMode = D1 (MetaData "MediaMode" "OpenTok.Session" "opentok-0.0.4-D6yY9RxUQIKFjtnnziRYka" False) (C1 (MetaCons "Relayed" PrefixI False) (U1 :: * -> *) :+: C1 (MetaCons "Routed" PrefixI False) (U1 :: * -> *))

data SessionOptions

Defines options for an OpenTok Session

MediaMode specifies how clients in the session will send audio and video streams.

ArchiveMode specifies how archives will be created.

An IPAddress may be provided as a location hint which will be when choosing an OpenTok Media Router for the session.

Instances

Show SessionOptions

Defined in OpenTok.Session

Methods

showsPrec :: Int -> SessionOptions -> ShowS

show :: SessionOptions -> String

showList :: [SessionOptions] -> ShowS

Generic SessionOptions

Defined in OpenTok.Session

Associated Types

type Rep SessionOptions :: * -> *

Methods

from :: SessionOptions -> Rep SessionOptions x

to :: Rep SessionOptions x -> SessionOptions

ToJSON SessionOptions

Defined in OpenTok.Session

Methods

toJSON :: SessionOptions -> Value

toEncoding :: SessionOptions -> Encoding

toJSONList :: [SessionOptions] -> Value

toEncodingList :: [SessionOptions] -> Encoding

type Rep SessionOptions

Defined in OpenTok.Session

type Rep SessionOptions = D1 (MetaData "SessionOptions" "OpenTok.Session" "opentok-0.0.4-D6yY9RxUQIKFjtnnziRYka" False) (C1 (MetaCons "SessionOptions" PrefixI True) (S1 (MetaSel (Just "_mediaMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MediaMode) :*: (S1 (MetaSel (Just "_archiveMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ArchiveMode) :*: S1 (MetaSel (Just "_location") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe IPAddress)))))

data Session

An OpenTok Session

Session {
  apiKey :: String,
  sessionId :: String,
  mediaMode :: MediaMode,
  archiveMode :: ArchiveMode
}

Instances

Show Session

Defined in OpenTok.Session

Methods

showsPrec :: Int -> Session -> ShowS

show :: Session -> String

showList :: [Session] -> ShowS

sessionOpts :: SessionOptions

Default Session options

SessionOptions
  { _mediaMode: Relayed
  , _archiveMode: Manual
  , _location: Nothing
}

create :: Client -> SessionOptions -> IO (Either OTError Session)

Create a new OpenTok Session