diff options
Diffstat (limited to 'device.h')
| -rw-r--r-- | device.h | 48 |
1 files changed, 24 insertions, 24 deletions
@@ -4,7 +4,7 @@ * See the main source file 'vdr.c' for copyright information and * how to reach the author. * - * $Id: device.h 2.46 2013/02/16 12:47:18 kls Exp $ + * $Id: device.h 2.47 2013/02/16 15:20:01 kls Exp $ */ #ifndef __DEVICE_H @@ -116,7 +116,7 @@ public: ///< Waits until all devices have become ready, or the given Timeout ///< (seconds) has expired. While waiting, the Ready() function of each ///< device is called in turn, until they all return true. - ///< \return True if all devices have become ready within the given + ///< Returns true if all devices have become ready within the given ///< timeout. static void SetUseDevice(int n); ///< Sets the 'useDevice' flag of the given device. @@ -127,8 +127,8 @@ public: ///< this instance of VDR. static bool SetPrimaryDevice(int n); ///< Sets the primary device to 'n'. - ///< \param n must be in the range 1...numDevices. - ///< \return true if this was possible. + ///< n must be in the range 1...numDevices. + ///< Returns true if this was possible. static cDevice *PrimaryDevice(void) { return primaryDevice; } ///< Returns the primary device. static cDevice *ActualDevice(void); @@ -136,8 +136,8 @@ public: ///< primary device otherwise. static cDevice *GetDevice(int Index); ///< Gets the device with the given Index. - ///< \param Index must be in the range 0..numDevices-1. - ///< \return A pointer to the device, or NULL if the Index was invalid. + ///< Index must be in the range 0..numDevices-1. + ///< Returns a pointer to the device, or NULL if the Index was invalid. static cDevice *GetDevice(const cChannel *Channel, int Priority, bool LiveView, bool Query = false); ///< Returns a device that is able to receive the given Channel at the ///< given Priority, with the least impact on active recordings and @@ -432,19 +432,19 @@ public: public: virtual uchar *GrabImage(int &Size, bool Jpeg = true, int Quality = -1, int SizeX = -1, int SizeY = -1); ///< Grabs the currently visible screen image. - ///< \param Size The size of the returned data block. - ///< \param Jpeg If true will write a JPEG file. Otherwise a PNM file will be written. - ///< \param Quality The compression factor for JPEG. 1 will create a very blocky - ///< and small image, 70..80 will yield reasonable quality images while keeping the - ///< image file size around 50 KB for a full frame. The default will create a big - ///< but very high quality image. - ///< \param SizeX The number of horizontal pixels in the frame (default is the current screen width). - ///< \param SizeY The number of vertical pixels in the frame (default is the current screen height). - ///< \return A pointer to the grabbed image data, or NULL in case of an error. + ///< Size is the size of the returned data block. + ///< If Jpeg is true it will write a JPEG file. Otherwise a PNM file will be written. + ///< Quality is the compression factor for JPEG. 1 will create a very blocky + ///< and small image, 70..80 will yield reasonable quality images while keeping the + ///< image file size around 50 KB for a full frame. The default will create a big + ///< but very high quality image. + ///< SizeX is the number of horizontal pixels in the frame (default is the current screen width). + ///< SizeY is the number of vertical pixels in the frame (default is the current screen height). + ///< Returns a pointer to the grabbed image data, or NULL in case of an error. ///< The caller takes ownership of the returned memory and must free() it once it isn't needed any more. bool GrabImageFile(const char *FileName, bool Jpeg = true, int Quality = -1, int SizeX = -1, int SizeY = -1); ///< Calls GrabImage() and stores the resulting image in a file with the given name. - ///< \return True if all went well. + ///< Returns true if all went well. ///< The caller is responsible for making sure that the given file name ///< doesn't lead to overwriting any important other file. @@ -509,7 +509,7 @@ public: ///< Index tells which track of the given basic type is meant. ///< If Id is 0 any existing id will be left untouched and only the ///< given Language and Description will be set. - ///< \return Returns true if the track was set correctly, false otherwise. + ///< Returns true if the track was set correctly, false otherwise. const tTrackId *GetTrack(eTrackType Type); ///< Returns a pointer to the given track id, or NULL if Type is not ///< less than ttMaxTrackTypes. @@ -525,14 +525,14 @@ public: eTrackType GetCurrentAudioTrack(void) const { return currentAudioTrack; } bool SetCurrentAudioTrack(eTrackType Type); ///< Sets the current audio track to the given Type. - ///< \return Returns true if Type is a valid audio track, false otherwise. + ///< Returns true if Type is a valid audio track, false otherwise. eTrackType GetCurrentSubtitleTrack(void) const { return currentSubtitleTrack; } bool SetCurrentSubtitleTrack(eTrackType Type, bool Manual = false); ///< Sets the current subtitle track to the given Type. ///< IF Manual is true, no automatic preferred subtitle language selection ///< will be done for the rest of the current replay session, or until ///< the channel is changed. - ///< \return Returns true if Type is a valid subtitle track, false otherwise. + ///< Returns true if Type is a valid subtitle track, false otherwise. void EnsureAudioTrack(bool Force = false); ///< Makes sure an audio track is selected that is actually available. ///< If Force is true, the language and Dolby Digital settings will @@ -593,13 +593,13 @@ protected: ///< Returns true if this device can currently start a replay session. virtual bool SetPlayMode(ePlayMode PlayMode); ///< Sets the device into the given play mode. - ///< \return true if the operation was successful. + ///< Returns true if the operation was successful. virtual int PlayVideo(const uchar *Data, int Length); ///< Plays the given data block as video. ///< Data points to exactly one complete PES packet of the given Length. ///< PlayVideo() shall process the packet either as a whole (returning ///< Length) or not at all (returning 0 or -1 and setting 'errno' accordingly). - ///< \return Returns the number of bytes actually taken from Data, or -1 + ///< Returns the number of bytes actually taken from Data, or -1 ///< in case of an error. virtual int PlayAudio(const uchar *Data, int Length, uchar Id); ///< Plays the given data block as audio. @@ -607,14 +607,14 @@ protected: ///< Id indicates the type of audio data this packet holds. ///< PlayAudio() shall process the packet either as a whole (returning ///< Length) or not at all (returning 0 or -1 and setting 'errno' accordingly). - ///< \return Returns the number of bytes actually taken from Data, or -1 + ///< Returns the number of bytes actually taken from Data, or -1 ///< in case of an error. virtual int PlaySubtitle(const uchar *Data, int Length); ///< Plays the given data block as a subtitle. ///< Data points to exactly one complete PES packet of the given Length. ///< PlaySubtitle() shall process the packet either as a whole (returning ///< Length) or not at all (returning 0 or -1 and setting 'errno' accordingly). - ///< \return Returns the number of bytes actually taken from Data, or -1 + ///< Returns the number of bytes actually taken from Data, or -1 ///< in case of an error. virtual int PlayPesPacket(const uchar *Data, int Length, bool VideoOnly = false); ///< Plays the single PES packet in Data with the given Length. @@ -658,7 +658,7 @@ public: ///< Only the lower 32 bit of this value are actually used, since some ///< devices can't handle the msb correctly. virtual bool IsPlayingVideo(void) const { return isPlayingVideo; } - ///< \return Returns true if the currently attached player has delivered + ///< Returns true if the currently attached player has delivered ///< any video packets. virtual cRect CanScaleVideo(const cRect &Rect, int Alignment = taCenter) { return cRect::Null; } ///< Asks the output device whether it can scale the currently shown video in |