epoc32/include/mmf/common/mmfvideo.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    18 #ifndef __MMF_COMMON_VIDEO_H__
    18 #ifndef __MMF_COMMON_VIDEO_H__
    19 #define __MMF_COMMON_VIDEO_H__
    19 #define __MMF_COMMON_VIDEO_H__
    20 
    20 
    21 #include <mmf/common/mmfutilities.h>
    21 #include <mmf/common/mmfutilities.h>
    22 
    22 
       
    23 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
    24 #include <mmf/common/mmfvideoenums.h>
       
    25 #endif
       
    26 
    23 class CFbsBitmap;
    27 class CFbsBitmap;
    24 
    28 
    25 /**
    29 /**
    26 @publishedAll
    30 @publishedAll
    27 @released
    31 @released
   307 	virtual CFbsBitmap& GetBitmap() = 0;
   311 	virtual CFbsBitmap& GetBitmap() = 0;
   308 	};
   312 	};
   309 
   313 
   310 /**
   314 /**
   311 @publishedAll
   315 @publishedAll
   312 @prototype
   316 @released
   313 
   317 
   314 Represents the video aspect ratio as a fraction: iNumerator/iDenominator.
   318 Represents the video aspect ratio as a fraction: iNumerator/iDenominator.
   315 */
   319 */
   316 class TVideoAspectRatio
   320 class TVideoAspectRatio
   317     {
   321     {
   378 	{
   382 	{
   379 	return ((iNumerator != aAspectRatio.iNumerator) || (iDenominator != aAspectRatio.iDenominator));
   383 	return ((iNumerator != aAspectRatio.iNumerator) || (iDenominator != aAspectRatio.iDenominator));
   380 	}
   384 	}
   381 
   385 
   382 /**
   386 /**
   383 Video playback rate capabilities. This structure defines playback rate
       
   384 capabilities for the current controller and video clip, and can be used
       
   385 to determine if fast forward, rewind, step forward, or step backward
       
   386 is possible.
       
   387 
       
   388 @publishedPartner
       
   389 @prototype
       
   390 
       
   391 @see CVideoPlayerUtility::GetPlayRateCapabilitiesL, CVideoPlayerUtility::SetPlayVelocityL
       
   392 */
       
   393 class TVideoPlayRateCapabilities
       
   394     {
       
   395 public:
       
   396     /**
       
   397     ETrue if fast or slow play forward is possible (i.e. playback
       
   398     velocity 1-99 or 101-). Normal play forward (velocity 100) is
       
   399     supported by default.
       
   400     */
       
   401     TBool iPlayForward;
       
   402 
       
   403     /**
       
   404     ETrue if play backward is possible (i.e. playback velocity below0).
       
   405     This includes normal speed, slow, and fast reverse playback.
       
   406     */
       
   407     TBool iPlayBackward;
       
   408 
       
   409     /** ETrue if step forward is possible */
       
   410     TBool iStepForward;
       
   411 
       
   412     /** Etrue if step backward is possible */
       
   413     TBool iStepBackward;
       
   414     };
       
   415     
       
   416 /**
       
   417 Automatic scaling type.
   387 Automatic scaling type.
   418 
   388 
   419 @publishedPartner
   389 @publishedAll
   420 @prototype
   390 @released
   421 
   391 
   422 @see CVideoPlayerUtility::SetAutoScaleL
   392 @see CVideoPlayerUtility::SetAutoScaleL
   423 */
   393 */
   424 enum TAutoScaleType
   394 enum TAutoScaleType
   425     {
   395     {
   451     };
   421     };
   452 
   422 
   453 /**
   423 /**
   454 Horizontal alignment for automatic scaling.
   424 Horizontal alignment for automatic scaling.
   455 
   425 
   456 @publishedPartner
   426 @publishedAll
   457 @prototype
   427 @released
   458 
   428 
   459 @see SetAutoScaleL
   429 @see SetAutoScaleL
   460 */
   430 */
   461 enum THorizontalAlign
   431 enum THorizontalAlign
   462 	{
   432 	{
   469 	};
   439 	};
   470 		
   440 		
   471 /**
   441 /**
   472 Vertical alignment for automatic scaling.
   442 Vertical alignment for automatic scaling.
   473 
   443 
   474 @publishedPartner
   444 @publishedAll
   475 @prototype
   445 @released
   476 
   446 
   477 @see SetAutoScaleL
   447 @see SetAutoScaleL
   478 */
   448 */
   479 enum TVerticalAlign
   449 enum TVerticalAlign
   480 	{
   450 	{
   483 	/** The picture is top-aligned */
   453 	/** The picture is top-aligned */
   484 	EVerticalAlignTop, 
   454 	EVerticalAlignTop, 
   485 	/** The picture is bottom-aligned */
   455 	/** The picture is bottom-aligned */
   486 	EVerticalAlignBottom 
   456 	EVerticalAlignBottom 
   487 	};
   457 	};
   488 
       
   489 /**
       
   490 Video quality.
       
   491 
       
   492 @publishedPartner
       
   493 @prototype
       
   494 
       
   495 @see CVideoPlayerUtility::SetVideoQualityL
       
   496 */
       
   497 enum TVideoQuality 
       
   498 	{
       
   499 	EVideoQualityLow = 25,
       
   500 	EVideoQualityNormal = 50,
       
   501 	EVideoQualityHigh = 75,
       
   502 	EVideoQualityLossless = 100
       
   503 	};
       
   504 	
   458 	
   505 #endif
   459 #endif