ESFIAPreferences

Inherits fromNSObject
FrameworkFlashInApp.framework
Declared in ESFIAPreferences.h
Companion guideFlash’In’App Programming Guide 
Required system version Mac OS X 10.4 and higher

 

Class description for ESFIAPreferences


ESFIAPreferences is the class, which adds global Flash’In’App settings such as setting plugin path, registration name and key, changing sound volume and mouse cursor settings.

 

Tasks of ESFIAPreferences


 

Class Methods of ESFIAPreferences


sharedPreferences
Returns the shared ESFIAPreferences instance, creating it if necessary.

+ (id) sharedPreferences;

Return Value
The shared preferences object.

 

Instance Methods of ESFIAPreferences


shouldOverrideMouseCursor

This method lets you know whether Flash’In’App overrides mouse cursor changes.

– (BOOL) shouldOverrideMouseCursor;

Return Value

Whether Flash’In’App overrides mouse cursor changes

Discussion

When using ESFlashView, if you change ZoomRect, then Adobe Flash Player plugin will apply “hand” cursor .

 

setShouldOverrideMouseCursor:

This method lets you specify whether Flash’In’App should override mouse cursor changes.

– (void) setShouldOverrideMouseCursor:(BOOL)aFlag;

Parameters

aFlag – mouse cursor changes

 

shouldOverrideSoundVolume

This method lets you specify whether Flash’In’App should override volume settings.
– (BOOL) shouldOverrideSoundVolume;

Return Value

Whether Flash’In’App should override volume settings

 

setShouldOverrideSoundVolume:

This method lets you specify whether Flash’In’App should override volume settings.

– (void) setShouldOverrideSoundVolume:(BOOL)aFlag;

Parameters

aFlag – volume value settings

NOTE, that this setting will be applied to the whole application.

 

setSoundVolume:

This method lets you set sound volume.
– (void) setSoundVolume:(float)aVolume;

Parameters
aVolume – volume value

NOTE, that it will be applied only if shouldOverrideSoundVolume returns YES.

 

soundVolume

This method lets you get sound volume.
– (float) soundVolume;

Return Value

Sound volume value

 

isSoundMuted

This method returns sound volume state.

– (BOOL) isSoundMuted;

Return Value

Whether sound is muted

 

setName:andKey:
This method sets registration name and key.

– (void) setName:(NSString *)aName andKey:(NSString *)aKey;

Parameters
aName – registration name
aKey – registration key

IMPORTANT! setName:andKey: method has to be called before loading any movie to register Flash’In’App, otherwise a demo reminder will be shown to user.

 

registrationName
This method gets registration name.
– (NSString *) registrationName;
Return Value
Registration name

 

registrationKey
This method gets registration key.
– (NSString *) registrationKey;
Return Value

Registration key

 

setFlashPluginPath:

This method sets the path value to Flash plugin.

– (void) setFlashPluginPath:(NSString *)aPath;

Parameters

aPath – Flash Plugin path

Discussion

Cannot be nil and should point to existing path. By default plugin will be loaded from Contents/PlugIns/Flash Player.plugin.

 

flashPluginPath

This method sets the path to the Flash plugin.

– (NSString *) flashPluginPath;

Return Value

The path to Flash plugin.

 

setRealPlayerPluginPath:

This method sets the path value to RealPlayer Plugin plugin.
 – (void) setRealPlayerPluginPath:(NSString *)aPath;

Parameters
aPath – Real Player Plugin path

Discussion

By default plugin will be loaded from /Library/Internet Plug-Ins/RealPlayer Plugin.plugin.

 

realPlayerPluginPath

This method returns current path to RealPlayer Plugin plugin.

– (NSString *) realPlayerPluginPath;

Return Value

Current path to the plugin

 

setSilverlightPluginPath:

This method sets the path value for Silverlight plugin.

– (void) setSilverlightPluginPath:(NSString *)aPath;

Parameters
aPath – Silverlight Plugin path

 

silverlightPluginPath

This method returns current path to Silverlight plugin.

– (NSString *) silverlightPluginPath;

Return Value

Current path to the plugin