VirtualBox

Changeset 75392 in vbox for trunk/src/VBox/Main/src-client


Ignore:
Timestamp:
Nov 12, 2018 9:48:37 AM (6 years ago)
Author:
vboxsync
Message:

Recording/Main: Docs.

Location:
trunk/src/VBox/Main/src-client
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/Main/src-client/Recording.cpp

    r75391 r75392  
    11/* $Id$ */
    22/** @file
    3  * Recording (with optional audio recording) code.
     3 * Recording context code.
    44 *
    55 * This code employs a separate encoding thread per recording context
    … …  
    175175 *
    176176 * @returns IPRT status code.
    177  * @param   a_Settings          Capture settings to use for context creation.
     177 * @param   a_Settings          Recording settings to use for context creation.
    178178 */
    179179int RecordingContext::createInternal(const settings::RecordingSettings &a_Settings)
    … …  
    223223}
    224224
     225/**
     226 * Starts a recording context by creating its worker thread.
     227 *
     228 * @returns IPRT status code.
     229 */
    225230int RecordingContext::startInternal(void)
    226231{
    … …  
    247252}
    248253
     254/**
     255 * Stops a recording context by telling the worker thread to stop and finalizing its operation.
     256 *
     257 * @returns IPRT status code.
     258 */
    249259int RecordingContext::stopInternal(void)
    250260{
    … …  
    275285
    276286/**
    277  * Destroys a recording context.
     287 * Destroys a recording context, internal version.
    278288 */
    279289int RecordingContext::destroyInternal(void)
    … …  
    324334}
    325335
     336/**
     337 * Returns a recording context's current settings.
     338 *
     339 * @returns The recording context's current settings.
     340 */
    326341const settings::RecordingSettings &RecordingContext::GetConfig(void) const
    327342{
    … …  
    329344}
    330345
     346/**
     347 * Returns the recording stream for a specific screen.
     348 *
     349 * @returns Recording stream for a specific screen, or NULL if not found.
     350 * @param   uScreen             Screen ID to retrieve recording stream for.
     351 */
    331352RecordingStream *RecordingContext::getStreamInternal(unsigned uScreen) const
    332353{
    … …  
    356377}
    357378
     379/**
     380 * Returns the number of configured recording streams for a recording context.
     381 *
     382 * @returns Number of configured recording streams.
     383 */
    358384size_t RecordingContext::GetStreamCount(void) const
    359385{
    … …  
    361387}
    362388
     389/**
     390 * Creates a new recording context.
     391 *
     392 * @returns IPRT status code.
     393 * @param   a_Settings          Recording settings to use for creation.
     394 *
     395 */
    363396int RecordingContext::Create(const settings::RecordingSettings &a_Settings)
    364397{
    … …  
    366399}
    367400
     401/**
     402 * Destroys a recording context.
     403 */
    368404int RecordingContext::Destroy(void)
    369405{
    … …  
    371407}
    372408
     409/**
     410 * Starts a recording context.
     411 *
     412 * @returns IPRT status code.
     413 */
    373414int RecordingContext::Start(void)
    374415{
    … …  
    376417}
    377418
     419/**
     420 * Stops a recording context.
     421 */
    378422int RecordingContext::Stop(void)
    379423{
    … …  
    381425}
    382426
     427/**
     428 * Returns if a specific recoding feature is enabled for at least one of the attached
     429 * recording streams or not.
     430 *
     431 * @returns \c true if at least one recording stream has this feature enabled, or \c false if
     432 *          no recording stream has this feature enabled.
     433 * @param   enmFeature          Recording feature to check for.
     434 */
    383435bool RecordingContext::IsFeatureEnabled(RecordingFeature_T enmFeature) const
    384436{
    … …  
    554606 */
    555607int RecordingContext::SendVideoFrame(uint32_t uScreen, uint32_t x, uint32_t y,
    556                                    uint32_t uPixelFormat, uint32_t uBPP, uint32_t uBytesPerLine,
    557                                    uint32_t uSrcWidth, uint32_t uSrcHeight, uint8_t *puSrcData,
    558                                    uint64_t uTimeStampMs)
     608                                     uint32_t uPixelFormat, uint32_t uBPP, uint32_t uBytesPerLine,
     609                                     uint32_t uSrcWidth, uint32_t uSrcHeight, uint8_t *puSrcData,
     610                                     uint64_t uTimeStampMs)
    559611{
    560612    AssertReturn(uSrcWidth,  VERR_INVALID_PARAMETER);

  • trunk/src/VBox/Main/src-client/RecordingStream.cpp

    r75391 r75392  
    182182}
    183183
     184/**
     185 * Parses an options string to configure advanced / hidden / experimental features of a recording stream.
     186 * Unknown values will be skipped.
     187 *
     188 * @returns IPRT status code.
     189 * @param   strOptions          Options string to parse.
     190 */
    184191int RecordingStream::parseOptionsString(const com::Utf8Str &strOptions)
    185192{
    … …  
    245252}
    246253
     254/**
     255 * Returns the recording stream's used configuration.
     256 *
     257 * @returns The recording stream's used configuration.
     258 */
    247259const settings::RecordingScreenSettings &RecordingStream::GetConfig(void) const
    248260{
    … …  
    251263
    252264/**
    253  * Checks if a specified limit for recording has been reached.
     265 * Checks if a specified limit for a recording stream has been reached.
    254266 *
    255267 * @returns true if any limit has been reached.
    … …  
    289301}
    290302
     303/**
     304 * Returns whether a recording stream is ready (e.g. enabled and active) or not.
     305 *
     306 * @returns \c true if ready, \c false if not.
     307 */
    291308bool RecordingStream::IsReady(void) const
    292309{
    … …  
    424441}
    425442
     443/**
     444 * Sends a raw (e.g. not yet encoded) video frame to the recording stream.
     445 *
     446 * @returns IPRT status code.
     447 * @param   x                   Upper left (X) coordinate where the video frame starts.
     448 * @param   y                   Upper left (Y) coordinate where the video frame starts.
     449 * @param   uPixelFormat        Pixel format of the video frame.
     450 * @param   uBPP                Bits per pixel (BPP) of the video frame.
     451 * @param   uBytesPerLine       Bytes per line  of the video frame.
     452 * @param   uSrcWidth           Width (in pixels) of the video frame.
     453 * @param   uSrcHeight          Height (in pixels) of the video frame.
     454 * @param   puSrcData           Actual pixel data of the video frame.
     455 * @param   uTimeStampMs        Timestamp (in ms) as PTS.
     456 */
    426457int RecordingStream::SendVideoFrame(uint32_t x, uint32_t y, uint32_t uPixelFormat, uint32_t uBPP, uint32_t uBytesPerLine,
    427                                   uint32_t uSrcWidth, uint32_t uSrcHeight, uint8_t *puSrcData, uint64_t uTimeStampMs)
     458                                    uint32_t uSrcWidth, uint32_t uSrcHeight, uint8_t *puSrcData, uint64_t uTimeStampMs)
    428459{
    429460    lock();
    … …  
    880911}
    881912
     913/**
     914 * Uninitializes a recording stream, internal version.
     915 *
     916 * @returns IPRT status code.
     917 */
    882918int RecordingStream::uninitInternal(void)
    883919{
    … …  
    905941
    906942/**
    907  * Uninitializes video recording for a certain recording stream.
     943 * Uninitializes video recording for a recording stream.
    908944 *
    909945 * @returns IPRT status code.
    … …  
    921957#ifdef VBOX_WITH_LIBVPX
    922958/**
    923  * Uninitializes the VPX codec for a certain recording stream.
     959 * Uninitializes the VPX codec for a recording stream.
    924960 *
    925961 * @returns IPRT status code.
    … …  
    939975
    940976/**
    941  * Initializes the video recording for a certain recording stream.
     977 * Initializes the video recording for a recording stream.
    942978 *
    943979 * @returns IPRT status code.
    … …  
    9711007#ifdef VBOX_WITH_LIBVPX
    9721008/**
    973  * Initializes the VPX codec for a certain recording stream.
     1009 * Initializes the VPX codec for a recording stream.
    9741010 *
    9751011 * @returns IPRT status code.
    … …  
    10271063#endif
    10281064
     1065/**
     1066 * Initializes the audio part of a recording stream,
     1067 *
     1068 * @returns IPRT status code.
     1069 */
    10291070int RecordingStream::initAudio(void)
    10301071{
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette