Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PVR] Correct interface documentation for PVR API GetStreamProperties() function #15480

Merged
merged 1 commit into from Feb 18, 2019

Conversation

Projects
None yet
3 participants
@djp952
Copy link
Contributor

commented Feb 10, 2019

Description

The PVR interface documentation for GetStreamProperties() is incorrect. This function is not called by Kodi if bHandlesInputStream is true. It is only called when bHandlesDemuxing is true.

Motivation and Context

While it would be great if this function was called when bHandlesInputStream is true as an alternative to GetChannelStreamProperties/GetRecordingStreamProperties, that is not the case.

How Has This Been Tested?

No testing - interface documentation change only via code comments

Screenshots (if appropriate):

Types of change

  • Bug fix (non-breaking change which fixes an issue)
  • Clean up (non-breaking change which removes non-working, unmaintained functionality)
  • Improvement (non-breaking change which improves existing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that will cause existing functionality to change)
  • Cosmetic change (non-breaking change that doesn't touch code)
  • None of the above (please explain below)

Checklist:

  • My code follows the Code Guidelines of this project
  • My change requires a change to the documentation, either Doxygen or wiki
  • I have updated the documentation accordingly
  • I have read the Contributing document
  • I have added tests to cover my change
  • All new and existing tests passed

@djp952 djp952 changed the title Correct interface documentation for PVR API GetStreamProperties() function [PVR] Correct interface documentation for PVR API GetStreamProperties() function Feb 10, 2019

@ksooo

ksooo approved these changes Feb 10, 2019

Copy link
Member

left a comment

Nice find. Thanks.

@ksooo
Copy link
Member

left a comment

Please remove the unrelated "close stream" commit from this PR.

@djp952

This comment has been minimized.

Copy link
Contributor Author

commented Feb 18, 2019

Sorry I didn't see this ksooo .. the offending commit has been removed. You should see only the header file commit now. djp952: sucking at git rebase since … forever.

@ksooo

This comment has been minimized.

Copy link
Member

commented Feb 18, 2019

Thanks.

@ksooo

ksooo approved these changes Feb 18, 2019

@ksooo

This comment has been minimized.

Copy link
Member

commented Feb 18, 2019

Jenkins error is unrelated.

@ksooo ksooo merged commit 255e8cc into xbmc:master Feb 18, 2019

1 check failed

default Sorry, building this PR failed. Please check the logs for the errors.
Details

@Rechi Rechi added this to the Leia 18.2-rc1 milestone Feb 18, 2019

@djp952 djp952 deleted the djp952:pvr-getstreampropscomment branch Apr 8, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.