Safe Haskell	None
Language	Haskell2010

OpenTok.Archive

Synopsis

data OutputMode
- = Composed
- | Individual
data ArchiveResolution
- = SD
- | HD
data ArchiveOptions = ArchiveOptions {
- _hasAudio :: Bool
- _hasVideo :: Bool
- _name :: Maybe String
- _outputMode :: OutputMode
- _resolution :: ArchiveResolution
- _sessionId :: SessionId
}
archiveOpts :: ArchiveOptions
data ArchiveStatus
- = Available
- | Expired
- | Failed
- | Paused
- | Started
- | Stopped
- | Uploaded
data Archive = Archive {
- id :: String
- status :: ArchiveStatus
- createdAt :: Integer
- size :: Int
- partnerId :: Int
- url :: Maybe String
- resolution :: ArchiveResolution
- outputMode :: OutputMode
- hasAudio :: Bool
- hasVideo :: Bool
- reason :: String
- name :: Maybe String
- updatedAt :: Integer
- duration :: Int
- sessionId :: String
}
data ListArchiveOptions = ListArchiveOptions {
- _forSessionId :: Maybe SessionId
- _offset :: Int
- _count :: Int
}
listArchiveOpts :: ListArchiveOptions
data ArchiveCollection = ArchiveCollection {
- count :: Int
- items :: [Archive]
}
start :: Client -> ArchiveOptions -> IO (Either OTError Archive)
stop :: Client -> ArchiveId -> IO (Either OTError Archive)
list :: Client -> ListArchiveOptions -> IO (Either OTError ArchiveCollection)
delete :: Client -> ArchiveId -> IO (Either OTError ArchiveId)

Documentation

data OutputMode Source #

Composed means that streams will be composed into a single file

Individual means that an individual file will be created for each stream

Constructors

Composed
Individual

Instances

Data OutputMode Source #
Instance details Defined in OpenTok.Archive Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> OutputMode -> c OutputMode # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c OutputMode # toConstr :: OutputMode -> Constr # dataTypeOf :: OutputMode -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c OutputMode) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c OutputMode) # gmapT :: (forall b. Data b => b -> b) -> OutputMode -> OutputMode # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> OutputMode -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> OutputMode -> r # gmapQ :: (forall d. Data d => d -> u) -> OutputMode -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> OutputMode -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> OutputMode -> m OutputMode # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> OutputMode -> m OutputMode # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> OutputMode -> m OutputMode #
Show OutputMode Source #
Instance details Defined in OpenTok.Archive Methods showsPrec :: Int -> OutputMode -> ShowS # show :: OutputMode -> String # showList :: [OutputMode] -> ShowS #
Generic OutputMode Source #
Instance details Defined in OpenTok.Archive Associated Types type Rep OutputMode :: * -> * # Methods from :: OutputMode -> Rep OutputMode x # to :: Rep OutputMode x -> OutputMode #
ToJSON OutputMode Source #
Instance details Defined in OpenTok.Archive Methods toJSON :: OutputMode -> Value # toEncoding :: OutputMode -> Encoding # toJSONList :: [OutputMode] -> Value # toEncodingList :: [OutputMode] -> Encoding #
FromJSON OutputMode Source #
Instance details Defined in OpenTok.Archive Methods parseJSON :: Value -> Parser OutputMode # parseJSONList :: Value -> Parser [OutputMode] #
type Rep OutputMode Source #
Instance details Defined in OpenTok.Archive type Rep OutputMode = D1 (MetaData "OutputMode" "OpenTok.Archive" "opentok-0.0.5-IcL1zYCkr65C5B0v2oYVUO" False) (C1 (MetaCons "Composed" PrefixI False) (U1 :: * -> ) :+: C1 (MetaCons "Individual" PrefixI False) (U1 :: -> *))

data ArchiveResolution Source #

SD (Standard Definition 640 x 480)

HD (High Definition 1280 x 720)

Constructors

SD
HD

Instances

Show ArchiveResolution Source #
Instance details Defined in OpenTok.Archive Methods showsPrec :: Int -> ArchiveResolution -> ShowS # show :: ArchiveResolution -> String # showList :: [ArchiveResolution] -> ShowS #
ToJSON ArchiveResolution Source #
Instance details Defined in OpenTok.Archive Methods toJSON :: ArchiveResolution -> Value # toEncoding :: ArchiveResolution -> Encoding # toJSONList :: [ArchiveResolution] -> Value # toEncodingList :: [ArchiveResolution] -> Encoding #
FromJSON ArchiveResolution Source #
Instance details Defined in OpenTok.Archive Methods parseJSON :: Value -> Parser ArchiveResolution # parseJSONList :: Value -> Parser [ArchiveResolution] #

data ArchiveOptions Source #

Defines options for an Archive

sessionId: The session to be archived

hasAudio: Whether the archive will record audio

hasVideo: Whether the archive will record video

name: The name of the archive

Whether all streams in the archive are recorded to a single file (Composed) or to individual files (Individual)

The resolution of the archive, either SD (the default, 640 x 480), or HD (1280 x 720)

Constructors

ArchiveOptions
Fields _hasAudio :: Bool _hasVideo :: Bool _name :: Maybe String _outputMode :: OutputMode _resolution :: ArchiveResolution _sessionId :: SessionId

Instances

Show ArchiveOptions Source #
Instance details Defined in OpenTok.Archive Methods showsPrec :: Int -> ArchiveOptions -> ShowS # show :: ArchiveOptions -> String # showList :: [ArchiveOptions] -> ShowS #
Generic ArchiveOptions Source #
Instance details Defined in OpenTok.Archive Associated Types type Rep ArchiveOptions :: * -> * # Methods from :: ArchiveOptions -> Rep ArchiveOptions x # to :: Rep ArchiveOptions x -> ArchiveOptions #
ToJSON ArchiveOptions Source #
Instance details Defined in OpenTok.Archive Methods toJSON :: ArchiveOptions -> Value # toEncoding :: ArchiveOptions -> Encoding # toJSONList :: [ArchiveOptions] -> Value # toEncodingList :: [ArchiveOptions] -> Encoding #
type Rep ArchiveOptions Source #
Instance details Defined in OpenTok.Archive type Rep ArchiveOptions = D1 (MetaData "ArchiveOptions" "OpenTok.Archive" "opentok-0.0.5-IcL1zYCkr65C5B0v2oYVUO" False) (C1 (MetaCons "ArchiveOptions" PrefixI True) ((S1 (MetaSel (Just "_hasAudio") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: (S1 (MetaSel (Just "_hasVideo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "_name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)))) :: (S1 (MetaSel (Just "_outputMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OutputMode) :: (S1 (MetaSel (Just "_resolution") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ArchiveResolution) :*: S1 (MetaSel (Just "_sessionId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SessionId)))))

archiveOpts :: ArchiveOptions Source #

Default Archive options

ArchiveOptions
  { _hasVideo   = True
  , _hasVideo   = True
  , _name       = Nothing
  , _outputMode = Composed
  , _resolution = SD
  , _sessionId  = ""
}

data ArchiveStatus Source #

Status of an OpenTok Archive

Constructors

Available
Expired
Failed
Paused
Started
Stopped
Uploaded

Instances

Data ArchiveStatus Source #
Instance details Defined in OpenTok.Archive Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ArchiveStatus -> c ArchiveStatus # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ArchiveStatus # toConstr :: ArchiveStatus -> Constr # dataTypeOf :: ArchiveStatus -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ArchiveStatus) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ArchiveStatus) # gmapT :: (forall b. Data b => b -> b) -> ArchiveStatus -> ArchiveStatus # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ArchiveStatus -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ArchiveStatus -> r # gmapQ :: (forall d. Data d => d -> u) -> ArchiveStatus -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ArchiveStatus -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ArchiveStatus -> m ArchiveStatus # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ArchiveStatus -> m ArchiveStatus # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ArchiveStatus -> m ArchiveStatus #
Show ArchiveStatus Source #
Instance details Defined in OpenTok.Archive Methods showsPrec :: Int -> ArchiveStatus -> ShowS # show :: ArchiveStatus -> String # showList :: [ArchiveStatus] -> ShowS #
Generic ArchiveStatus Source #
Instance details Defined in OpenTok.Archive Associated Types type Rep ArchiveStatus :: * -> * # Methods from :: ArchiveStatus -> Rep ArchiveStatus x # to :: Rep ArchiveStatus x -> ArchiveStatus #
ToJSON ArchiveStatus Source #
Instance details Defined in OpenTok.Archive Methods toJSON :: ArchiveStatus -> Value # toEncoding :: ArchiveStatus -> Encoding # toJSONList :: [ArchiveStatus] -> Value # toEncodingList :: [ArchiveStatus] -> Encoding #
FromJSON ArchiveStatus Source #
Instance details Defined in OpenTok.Archive Methods parseJSON :: Value -> Parser ArchiveStatus # parseJSONList :: Value -> Parser [ArchiveStatus] #
type Rep ArchiveStatus Source #
Instance details Defined in OpenTok.Archive type Rep ArchiveStatus = D1 (MetaData "ArchiveStatus" "OpenTok.Archive" "opentok-0.0.5-IcL1zYCkr65C5B0v2oYVUO" False) ((C1 (MetaCons "Available" PrefixI False) (U1 :: * -> ) :+: (C1 (MetaCons "Expired" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "Failed" PrefixI False) (U1 :: -> ))) :+: ((C1 (MetaCons "Paused" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "Started" PrefixI False) (U1 :: -> )) :+: (C1 (MetaCons "Stopped" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "Uploaded" PrefixI False) (U1 :: -> *))))

data Archive Source #

An OpenTok Archive

Archive {
  id :: String,
  status :: ArchiveStatus,
  createdAt :: Integer,
  size :: Int,
  partnerId :: Int,
  url :: Maybe String,
  resolution :: ArchiveResolution,
  outputMode :: OutputMode,
  hasAudio :: Bool,
  hasVideo :: Bool,
  reason :: String,
  name :: String,
  updatedAt :: Integer,
  duration :: Int,
  sessionId :: String
}

Constructors

Archive
Fields id :: String status :: ArchiveStatus createdAt :: Integer size :: Int partnerId :: Int url :: Maybe String resolution :: ArchiveResolution outputMode :: OutputMode hasAudio :: Bool hasVideo :: Bool reason :: String name :: Maybe String updatedAt :: Integer duration :: Int sessionId :: String

Instances

Show Archive Source #
Instance details Defined in OpenTok.Archive Methods showsPrec :: Int -> Archive -> ShowS # show :: Archive -> String # showList :: [Archive] -> ShowS #
Generic Archive Source #
Instance details Defined in OpenTok.Archive Associated Types type Rep Archive :: * -> * # Methods from :: Archive -> Rep Archive x # to :: Rep Archive x -> Archive #
FromJSON Archive Source #
Instance details Defined in OpenTok.Archive Methods parseJSON :: Value -> Parser Archive # parseJSONList :: Value -> Parser [Archive] #
type Rep Archive Source #
Instance details Defined in OpenTok.Archive type Rep Archive = D1 (MetaData "Archive" "OpenTok.Archive" "opentok-0.0.5-IcL1zYCkr65C5B0v2oYVUO" False) (C1 (MetaCons "Archive" PrefixI True) (((S1 (MetaSel (Just "id") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String) :: (S1 (MetaSel (Just "status") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ArchiveStatus) :: S1 (MetaSel (Just "createdAt") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer))) :: ((S1 (MetaSel (Just "size") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "partnerId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int)) :: (S1 (MetaSel (Just "url") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :: S1 (MetaSel (Just "resolution") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ArchiveResolution)))) :: (((S1 (MetaSel (Just "outputMode") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OutputMode) :: S1 (MetaSel (Just "hasAudio") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool)) :: (S1 (MetaSel (Just "hasVideo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Bool) :: S1 (MetaSel (Just "reason") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))) :: ((S1 (MetaSel (Just "name") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :: S1 (MetaSel (Just "updatedAt") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Integer)) :: (S1 (MetaSel (Just "duration") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :: S1 (MetaSel (Just "sessionId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String))))))

data ListArchiveOptions Source #

Options for listing archives

ListArchiveOptions {
  _forSessionId :: Maybe SessionId,
  _count :: Int,
  _offset :: Int
}

Constructors

ListArchiveOptions
Fields _forSessionId :: Maybe SessionId _offset :: Int _count :: Int

listArchiveOpts :: ListArchiveOptions Source #

Default List Archive options

ListArchiveOptions
  { _forSessionId = Nothing
  , _offset     = 0
  , _count      = 50
}

data ArchiveCollection Source #

An OpenTok Archive Collection

ArchiveCollection {
  count :: Int
  items :: [Archive]
}

Constructors

ArchiveCollection
Fields count :: Int items :: [Archive]

Instances

Show ArchiveCollection Source #
Instance details Defined in OpenTok.Archive Methods showsPrec :: Int -> ArchiveCollection -> ShowS # show :: ArchiveCollection -> String # showList :: [ArchiveCollection] -> ShowS #
Generic ArchiveCollection Source #
Instance details Defined in OpenTok.Archive Associated Types type Rep ArchiveCollection :: * -> * # Methods from :: ArchiveCollection -> Rep ArchiveCollection x # to :: Rep ArchiveCollection x -> ArchiveCollection #
FromJSON ArchiveCollection Source #
Instance details Defined in OpenTok.Archive Methods parseJSON :: Value -> Parser ArchiveCollection # parseJSONList :: Value -> Parser [ArchiveCollection] #
type Rep ArchiveCollection Source #
Instance details Defined in OpenTok.Archive type Rep ArchiveCollection = D1 (MetaData "ArchiveCollection" "OpenTok.Archive" "opentok-0.0.5-IcL1zYCkr65C5B0v2oYVUO" False) (C1 (MetaCons "ArchiveCollection" PrefixI True) (S1 (MetaSel (Just "count") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Just "items") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Archive])))

start :: Client -> ArchiveOptions -> IO (Either OTError Archive) Source #

stop :: Client -> ArchiveId -> IO (Either OTError Archive) Source #

list :: Client -> ListArchiveOptions -> IO (Either OTError ArchiveCollection) Source #

delete :: Client -> ArchiveId -> IO (Either OTError ArchiveId) Source #