KDE::PlayObjectFactory Class Reference

#include <kplayobjectfactory.h>

Public Member Functions
	PlayObjectFactory (Arts::SoundServerV2 server)
	PlayObjectFactory (KArtsServer *server)
void	setAudioManagerPlay (KAudioManagerPlay *amanplay)
KDE::PlayObject *	createPlayObject (const KURL &url, bool createBUS)
KDE::PlayObject *	createPlayObject (const KURL &url, const TQString &mimetype, bool createBUS)
void	setAllowStreaming (bool s)
bool	allowStreaming ()

Static Public Member Functions
static TQStringList	mimeTypes (void)

Detailed Description

This class implements a factory to create KDE::PlayObjects for a given URL and mimetype.

A detailed description about how to use the KDE multimedia framework can be found in the documentation for KDE::PlayObject.

Definition at line 79 of file kplayobjectfactory.h.

Constructor & Destructor Documentation

PlayObjectFactory() [1/2]

KDE::PlayObjectFactory::PlayObjectFactory

(

Arts::SoundServerV2

server

)

Creates a KDE::PlayObjectFactory.

server is an Arts::SoundServerV2

Definition at line 97 of file kplayobjectfactory.cpp.

PlayObjectFactory() [2/2]

KDE::PlayObjectFactory::PlayObjectFactory

(

KArtsServer *

server

)

Convenience constructor to pass a KArtsServer instead of an Arts::SoundServerV2.

This equivalent to calling KDE::PlayObjectFactory( server.server() ).

Since

3.2

Definition at line 107 of file kplayobjectfactory.cpp.

Member Function Documentation

allowStreaming()

bool KDE::PlayObjectFactory::allowStreaming ( )

inline

returns "true" if the factory is allowed to create streaming PlayObjects.

Definition at line 132 of file kplayobjectfactory.h.

createPlayObject() [1/2]

KDE::PlayObject * KDE::PlayObjectFactory::createPlayObject	(	const KURL &	url,
		bool	createBUS
	)

Creates a KDE::PlayObject to play back the file or stream url points to.

Set createBUS to "true", if you want the PlayObject to be connected to a SYNTH_BUS_UPLINK on creation. This is usually the case. You only need to set this to "false" if you want to attach your own sound effects to the PlayObject.

You don't need to know the mimetype of the file or stream, it will be detected automatically.

Definition at line 130 of file kplayobjectfactory.cpp.

createPlayObject() [2/2]

KDE::PlayObject * KDE::PlayObjectFactory::createPlayObject	(	const KURL &	url,
		const TQString &	mimetype,
		bool	createBUS
	)

This method also creates a KDE::PlayObject, but does no automatic mimetype detection.

Use this method with care.

Definition at line 136 of file kplayobjectfactory.cpp.

mimeTypes()

TQStringList KDE::PlayObjectFactory::mimeTypes ( void  )

static

Return the mimetypes that are playable.

Definition at line 190 of file kplayobjectfactory.cpp.

setAllowStreaming()

void KDE::PlayObjectFactory::setAllowStreaming ( bool  s )

inline

setAllowStreaming( true ) allows the factory to create a streaming PlayObject for a non-local URL.

This is also the default. Usually, you should not need to set this to false.

Definition at line 126 of file kplayobjectfactory.h.

setAudioManagerPlay()

void KDE::PlayObjectFactory::setAudioManagerPlay

(

KAudioManagerPlay *

amanplay

)

If this is set the PlayObject doesn't create a Synth_BUS_UPLINK at all but always uses the Synth_AMAN_PLAY that you passed.

Definition at line 123 of file kplayobjectfactory.cpp.

---

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

• kplayobjectfactory.h
• kplayobjectfactory.cpp