Developers: breaking changes forthcoming in 1.30.0

[chocolateboy]

There will be several backwards-incompatible internal changes in the forthcoming 1.30.0 release. These don't affect users directly, but may affect developers of plugins or unofficial builds.

Firstly, the PmsConfiguration method getProfileDir has been renamed getProfileDirectory. This may impact custom builds.

Secondly, the Player.launchTranscode method now has a new signature:

Code: Select all

    public ProcessWrapper launchTranscode(
        String filename,
        DLNAResource dlna,
        DLNAMediaInfo media,
        OutputParams params
    ) throws IOException;


Note the new DLNAResource argument. The latter change enables a new plugin hook: finalizeTranscoderArgs.

Finally (this is a non-breaking change unless you were relying on a bug), plugin developers might want to take another look at the StartStopListener interface, as it should now more closely reflect the expected behaviour.

[taconaut]

In r695, some of the classes responsible for populating the tabs in the GUI were renamed to make them easier to identify. This may affect packagers of custom builds, but shouldn't affect plugin developers:

• The old AboutTab has been deleted (it was unused)
• LinksTab has been renamed to AboutTab
• NetworkTab has been renamed to GeneralTab
• FoldTab has been renamed to NavigationShareTab
• TrTab2 has been renamed to TranscodingTab

[tomeko]

Removed method: isAnalyzeFolderAllFiles (required for all renderers that don't support shagrath's hack)
replaced with method method isDLNATreeHack (introduced with r691) that checks whether renderer supports creating DLNA tree on the fly with fake <TotalMatches> value (enabled with CreateDLNATreeFaster renderer file option). With this, browsing is faster, but it violates upnp specification and is not supported with some renderers.

[taconaut]

In r706 and r707 the root folder management has been completely reworked. RootFolder now manages itself and doesn't need the manageRoot() method in PMS.java any more.

Changes:

• 'private RootFolder getRootFolder(RendererConfiguration renderer, boolean initialize)' has been removed as the initialization is being managed by RootFolder itself. 'public RootFolder getRootFolder(RendererConfiguration renderer)' remains.
• Removed method 'public void manageRoot(RendererConfiguration renderer)'. Initialization is being done in discoverChildren in RootFolder
• Removed public methods addiPhotoFolder, addiTunesFolder, addVideoSettingssFolder, addMediaLibraryFolder (and private methods required by these methods). They now live in RootFolder as e.g. getiPhotoFolder. The only method still called add... is addWebFolder because the logic would have had to be adapted to make a getWebFolder out of it.
• Removed is/setMediaLibraryAdded methods in RendererConfiguration because they aren't needed anymore.
• Removed 'public RootFolder getRootFolder(boolean initialize)' in RendererConfiguration because initialization is managed by RootFolder now
• Removed methods 'public void browse(File startFolders[])' and 'public void browse(List<MapFileConfiguration> startVirtualFolders)' in RootFolder because they are now managed internally
• Removed method 'public boolean refreshChildren()' in RootFolder. Populate the children in discoverChildren()

[taconaut]

In r711 all main methods beside the one contained in PMS.java have been deleted.
For test cases like e.g. Version.java the test case should be implemented in a separate class.

Affected classes are: RendererConfiguration.java, AviDemuxerInputStream.java, WindowsNamedPipe.java, WinUtils.java, Proxy.java, ProxyServer.java, Version.java, DTSAudioOutputStream.java, H264AnnexBInputStream.java, PCMAudioOutputStream.java