X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=mlt%2B%2B%2FREADME;fp=mlt%2B%2B%2FREADME;h=d6d1b1c8c811d312c0ae9fc34ac498083a3b98c6;hb=01116637238e74419971afc26311c7a65b7b43aa;hp=f4e8bedc7546fb30b59f11569de2177bf83e7765;hpb=4bf33d8de1c1887c6386f8d151c479ae0631a9aa;p=melted diff --git a/mlt++/README b/mlt++/README index f4e8bed..d6d1b1c 100644 --- a/mlt++/README +++ b/mlt++/README @@ -15,8 +15,17 @@ USAGE Use the following definitions in a Makefile to compile and link with mlt++: - CXXFLAGS=`mlt-config -Wall` - LDFLAGS=-lmlt++ + CXXFLAGS=`mlt-config -Wall` + LDFLAGS=-lmlt++ + + Include files for the classes can either be explicitly included, ie: + + #include + etc + + Or you can include all using: + + #include All definitions are placed in an Mlt namespace, and adhere closely to the C naming convention. Mappings always follow the pattern: @@ -39,6 +48,12 @@ USAGE ie: mlt_playlist_append ==> Mlt::Playlist.append etc + Additionally, you can specify: + + using namespace Mlt; + + To avoid the enforced use of the Mlt:: prefix. + Enumerators and macros are reused directly from the C library. CLASS HIERARCHY @@ -72,24 +87,25 @@ SPECIAL CASES Note that you get an object back - it is never the original object, but a wrapping object. This is done to keep consistency with the C api which may - instantiate C instances - therefore there it cannot be assumed that a C++ - object exists for all mlt service instances. + instantiate C instances - therefore it cannot be assumed that a C++ object + exists for all mlt service instances. As such, it is mandatory that you delete these objects. The original will - not be affected. Further to that, all modifications (to properties or its + not be affected. However, all other modifications (to properties or its state of connection) will be reflected in the original object. - This excludes the use of the RTTI to determine the real type of the object - - this can only be done by parsing the objects properties. + This approach excludes the use of RTTI to determine the real type of the + object - this can only be done by parsing the objects properties. - Non-NULL objects may be invalid - always use the is_valid method to - check validity before use. + Objects may be invalid - always use the is_valid method to check validity + before use. LIMITATIONS ----------- - The mechanisms for the definition of new services have deliberately not - been exposed by the C++ wrappings - this is done to ensure that service + The mechanisms for the definition of new services are deliberately + excluded from the C++ wrappings - this is done to ensure that service networks constructed can be serialised and used by existing applications which are based on the C API (such as miracle). +