EMIPLIB
Public Types | Public Member Functions

MIPVideoSessionParams Class Reference

Parameters for a video session. More...

#include <mipvideosession.h>

List of all members.

Public Types

enum  SessionType { InputOutput, OutputOnly }
 

Specifies the type of session that will be used.

More...
enum  EncodingType { H263, IntH263, IntYUV420 }
 

Specifies the encoding/compression of outgoing video frames.

More...

Public Member Functions

int getDeviceNumber () const
 Returns the device number to open (only used on Win32; default: 0).
std::string getDeviceName () const
 Returns the device name (not used on Win32; default: /dev/video0).
int getWidth () const
 Returns the width (default: 160).
int getHeight () const
 Returns the height (default: 120).
real_t getFrameRate () const
 Returns the frame rate (default: 15.0).
uint16_t getPortbase () const
 Returns the RTP portbase (default: 5100).
bool getAcceptOwnPackets () const
 Returns true if own packets will be accepted (default: false).
int getBandwidth () const
 Returns the bandwidth that can be used (default: 200000).
bool getUseQtOutput () const
 Returns flag indicating if a Qt output component will be used or if a video frame storage component will be used (default: true).
SessionType getSessionType () const
 Returns the type of session that will be created (default: MIPVideoSessionParams::InputOutput).
uint8_t getIncomingH263PayloadType () const
 Returns the payload type that should used to interpret incoming packets as H.263 encoded video, stored in RTP packets in the standard way (default: 34).
uint8_t getOutgoingH263PayloadType () const
 Returns the payload type that will be set on outgoing RTP packets if they contain H.263 video stored in the standard way (default: 34).
uint8_t getIncomingInternalPayloadType () const
 Returns the payload type that should used to interpret incoming packets as video packets using an internal encoding format (default: 103).
uint8_t getOutgoingInternalPayloadType () const
 Returns the payload type that will be set on outgoing RTP packets if they contain video stored in the non-standard, internal format (default: 103).
EncodingType getEncodingType () const
 Returns the encoding that outgoing video frames will have (default: MIPVideoSessionParams::H263).
bool getWaitForKeyframe () const
 Returns true if video frames should only be shown after a keyframe has been received (default: true).
int getMaximumPayloadSize () const
 Returns the maximum payload size a single RTP packet may have, before splitting data over multiple packets (default: 64000).
void setDevice (int n)
 Sets the number of the input device to use (only used on Win32).
void setDevice (const std::string &devName)
 Sets the name of the device (not used on Win32).
void setWidth (int w)
 Sets the width of the video frames.
void setHeight (int h)
 Sets the height of the video frames.
void setBandwidth (int b)
 Sets the bandwidth.
void setFrameRate (real_t r)
 Sets the frame rate.
void setPortbase (uint16_t p)
 Sets the RTP portbase.
void setAcceptOwnPackets (bool v)
 Sets a flag indicating if own packets should be accepted.
void setUseQtOutput (bool f)
 Sets flag if Qt output component should be used or a if video frame storage component should be used.
void setSessionType (SessionType s)
 Sets the current session type.
void setIncomingH263PayloadType (uint8_t pt)
 Sets the payload type that will be used to interpret RTP packets as standard H.263 encoded video.
void setOutgoingH263PayloadType (uint8_t pt)
 Sets the payload type that will be used for outgoing messages when sending H.263 data in the standard way.
void setIncomingInternalPayloadType (uint8_t pt)
 Sets the payload type that will be used to interpret RTP packets as video frames which use an internal RTP format.
void setOutgoingInternalPayloadType (uint8_t pt)
 Sets the payload type that will be used for outgoing messages when sending video frames using the non-standard, internal payload format.
void setEncodingType (EncodingType t)
 Sets the current encoding type.
void setWaitForKeyframe (bool w)
 If set to true, video frames will only be shown after a keyframe has been received.
void setMaximumPayloadSize (int s)
 Sets the maximum size the payload of an RTP packet may have before splitting it over multiple RTP packets.

Detailed Description


Member Enumeration Documentation

Enumerator:
H263 

H.263 compression is used, in an RTP format based on RFC 4629.

IntH263 

H.263 compression is used, but stored in RTP packets using an internal format, not compatible with other software.

IntYUV420 

Raw YUV420P frames will be sent, using an internal format for storage into RTP packets.

Enumerator:
InputOutput 

Both video capture and playback will take place.

OutputOnly 

Received video will be shown, but no frames will be captured locally.


Member Function Documentation

bool MIPVideoSessionParams::getAcceptOwnPackets ( ) const [inline]
int MIPVideoSessionParams::getBandwidth ( ) const [inline]
std::string MIPVideoSessionParams::getDeviceName ( ) const [inline]
int MIPVideoSessionParams::getDeviceNumber ( ) const [inline]
real_t MIPVideoSessionParams::getFrameRate ( ) const [inline]
int MIPVideoSessionParams::getHeight ( ) const [inline]
uint16_t MIPVideoSessionParams::getPortbase ( ) const [inline]
SessionType MIPVideoSessionParams::getSessionType ( ) const [inline]
int MIPVideoSessionParams::getWidth ( ) const [inline]
void MIPVideoSessionParams::setAcceptOwnPackets ( bool  v) [inline]
void MIPVideoSessionParams::setBandwidth ( int  b) [inline]
void MIPVideoSessionParams::setDevice ( int  n) [inline]
void MIPVideoSessionParams::setDevice ( const std::string &  devName) [inline]
void MIPVideoSessionParams::setEncodingType ( EncodingType  t) [inline]
void MIPVideoSessionParams::setFrameRate ( real_t  r) [inline]
void MIPVideoSessionParams::setHeight ( int  h) [inline]
void MIPVideoSessionParams::setPortbase ( uint16_t  p) [inline]
void MIPVideoSessionParams::setSessionType ( SessionType  s) [inline]
void MIPVideoSessionParams::setWidth ( int  w) [inline]

The documentation for this class was generated from the following file: